diff --git a/cloudstack/BackupService.go b/cloudstack/BackupService.go index 454b12e..bdfde23 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 66d4e34..12af665 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 7e9cfd6..571b85c 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 78774b2..16f9009 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 3b7c044..1e2c53c 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 373ec6c..8639235 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"` @@ -1815,6 +1841,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"` @@ -2461,6 +2488,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"` @@ -2592,6 +2620,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"` @@ -2936,6 +2965,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"` @@ -3483,6 +3513,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"` @@ -3640,6 +3671,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"` diff --git a/cloudstack/LDAPService.go b/cloudstack/LDAPService.go index cc8af48..b2ab062 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 09b77d5..9dadf6a 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 8452cf0..c66a8c0 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 77c2047..ea4e367 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 10b35bf..96f1a2e 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 afad806..fb50127 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 885a44c..9ea2f50 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 9d47790..ed27a8c 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 61238ab..372b4ed 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 b1a148a..ab11f36 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 ea964ad..9a1c0ff 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 f5d5ad2..f024d06 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 9a1c490..e9f9071 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/UsageService.go b/cloudstack/UsageService.go index ef89ced..13e195b 100644 --- a/cloudstack/UsageService.go +++ b/cloudstack/UsageService.go @@ -21,7 +21,6 @@ package cloudstack import ( "encoding/json" - "fmt" "net/url" "strconv" ) @@ -43,7 +42,6 @@ type UsageServiceIface interface { NewListTrafficTypeImplementorsParams() *ListTrafficTypeImplementorsParams ListTrafficTypes(p *ListTrafficTypesParams) (*ListTrafficTypesResponse, error) NewListTrafficTypesParams(physicalnetworkid string) *ListTrafficTypesParams - GetTrafficTypeID(keyword string, physicalnetworkid string, opts ...OptionFunc) (string, int, error) ListUsageRecords(p *ListUsageRecordsParams) (*ListUsageRecordsResponse, error) NewListUsageRecordsParams(enddate string, startdate string) *ListUsageRecordsParams ListUsageTypes(p *ListUsageTypesParams) (*ListUsageTypesResponse, error) @@ -1215,43 +1213,6 @@ func (s *UsageService) NewListTrafficTypesParams(physicalnetworkid string) *List return p } -// This is a courtesy helper function, which in some cases may not work as expected! -func (s *UsageService) GetTrafficTypeID(keyword string, physicalnetworkid string, opts ...OptionFunc) (string, int, error) { - p := &ListTrafficTypesParams{} - p.p = make(map[string]interface{}) - - p.p["keyword"] = keyword - p.p["physicalnetworkid"] = physicalnetworkid - - for _, fn := range append(s.cs.options, opts...) { - if err := fn(s.cs, p); err != nil { - return "", -1, err - } - } - - l, err := s.ListTrafficTypes(p) - if err != nil { - return "", -1, err - } - - if l.Count == 0 { - return "", l.Count, fmt.Errorf("No match found for %s: %+v", keyword, l) - } - - if l.Count == 1 { - return l.TrafficTypes[0].Id, l.Count, nil - } - - if l.Count > 1 { - for _, v := range l.TrafficTypes { - if v.Name == keyword { - return v.Id, l.Count, nil - } - } - } - return "", l.Count, fmt.Errorf("Could not find an exact match for %s: %+v", keyword, l) -} - // Lists traffic types of a given physical network. func (s *UsageService) ListTrafficTypes(p *ListTrafficTypesParams) (*ListTrafficTypesResponse, error) { resp, err := s.cs.newRequest("listTrafficTypes", p.toURLValues()) @@ -1273,15 +1234,16 @@ type ListTrafficTypesResponse struct { } type TrafficType struct { - Canenableindividualservice bool `json:"canenableindividualservice"` - Destinationphysicalnetworkid string `json:"destinationphysicalnetworkid"` - Id string `json:"id"` - JobID string `json:"jobid"` - Jobstatus int `json:"jobstatus"` - Name string `json:"name"` - Physicalnetworkid string `json:"physicalnetworkid"` - Servicelist []string `json:"servicelist"` - State string `json:"state"` + Hypervnetworklabel string `json:"hypervnetworklabel"` + Id string `json:"id"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Kvmnetworklabel string `json:"kvmnetworklabel"` + Ovm3networklabel string `json:"ovm3networklabel"` + Physicalnetworkid string `json:"physicalnetworkid"` + Traffictype string `json:"traffictype"` + Vmwarenetworklabel string `json:"vmwarenetworklabel"` + Xennetworklabel string `json:"xennetworklabel"` } type ListUsageRecordsParams struct { diff --git a/cloudstack/UsageService_mock.go b/cloudstack/UsageService_mock.go index ba39044..7a7acf9 100644 --- a/cloudstack/UsageService_mock.go +++ b/cloudstack/UsageService_mock.go @@ -133,27 +133,6 @@ func (mr *MockUsageServiceIfaceMockRecorder) GenerateUsageRecords(p any) *gomock return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "GenerateUsageRecords", reflect.TypeOf((*MockUsageServiceIface)(nil).GenerateUsageRecords), p) } -// GetTrafficTypeID mocks base method. -func (m *MockUsageServiceIface) GetTrafficTypeID(keyword, physicalnetworkid string, opts ...OptionFunc) (string, int, error) { - m.ctrl.T.Helper() - varargs := []any{keyword, physicalnetworkid} - for _, a := range opts { - varargs = append(varargs, a) - } - ret := m.ctrl.Call(m, "GetTrafficTypeID", varargs...) - ret0, _ := ret[0].(string) - ret1, _ := ret[1].(int) - ret2, _ := ret[2].(error) - return ret0, ret1, ret2 -} - -// GetTrafficTypeID indicates an expected call of GetTrafficTypeID. -func (mr *MockUsageServiceIfaceMockRecorder) GetTrafficTypeID(keyword, physicalnetworkid any, opts ...any) *gomock.Call { - mr.mock.ctrl.T.Helper() - varargs := append([]any{keyword, physicalnetworkid}, opts...) - return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "GetTrafficTypeID", reflect.TypeOf((*MockUsageServiceIface)(nil).GetTrafficTypeID), varargs...) -} - // ListTrafficMonitors mocks base method. func (m *MockUsageServiceIface) ListTrafficMonitors(p *ListTrafficMonitorsParams) (*ListTrafficMonitorsResponse, error) { m.ctrl.T.Helper() diff --git a/cloudstack/VirtualMachineService.go b/cloudstack/VirtualMachineService.go index 04d3092..ecdbdd5 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 017bfea..69b821c 100644 --- a/generate/listApis.json +++ b/generate/listApis.json @@ -5,6 +5,20 @@ "isasync": true, "name": "createVPCOffering", "params": [ + { + "description": "the name of the vpc 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", + "length": 255, + "name": "serviceproviderlist", + "required": false, + "type": "map" + }, { "description": "desired service capabilities as part of vpc offering", "length": 255, @@ -14,18 +28,19 @@ "type": "map" }, { - "description": "the routing mode for the VPC offering. Supported types are: Static or Dynamic.", + "description": "Indicates the mode with which the network will operate. Valid option: NATTED or ROUTED", "length": 255, - "name": "routingmode", + "name": "networkmode", "required": false, "since": "4.20.0", "type": "string" }, { - "description": "the display text of the vpc offering, defaults to the 'name'", + "description": "the routing mode for the VPC offering. Supported types are: Static or Dynamic.", "length": 255, - "name": "displaytext", + "name": "routingmode", "required": false, + "since": "4.20.0", "type": "string" }, { @@ -36,28 +51,6 @@ "since": "4.20.0", "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", - "length": 255, - "name": "internetprotocol", - "required": false, - "since": "4.17.0", - "type": "string" - }, { "description": "set to true if the offering is to be enabled during creation. Default is false", "length": 255, @@ -75,35 +68,27 @@ "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": "true if network offering for NSX VPC offering supports Load balancer service.", "length": 255, - "name": "networkmode", + "name": "nsxsupportlb", "required": false, "since": "4.20.0", - "type": "string" + "type": "boolean" }, { - "description": "the ID of the containing zone(s), null for public offerings", + "description": "Name of the provider providing the service", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "provider", "required": false, - "since": "4.13", - "type": "list" + "since": "4.21.0", + "type": "string" }, { - "description": "Name of the provider providing the service", + "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": "provider", + "name": "internetprotocol", "required": false, - "since": "4.21.0", + "since": "4.17.0", "type": "string" }, { @@ -123,12 +108,27 @@ "type": "list" }, { - "description": "true if network offering for NSX VPC offering supports Load balancer service.", + "description": "services supported by the vpc offering", "length": 255, - "name": "nsxsupportlb", + "name": "supportedservices", "required": false, - "since": "4.20.0", - "type": "boolean" + "type": "list" + }, + { + "description": "the ID of the containing zone(s), null for public offerings", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "since": "4.13", + "type": "list" + }, + { + "description": "the display text of the vpc offering, defaults to the 'name'", + "length": 255, + "name": "displaytext", + "required": false, + "type": "string" } ], "related": "updateVPCOffering,listVPCOfferings", @@ -139,44 +139,50 @@ "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", + "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": "Mode in which the network will operate. The valid values are NATTED and ROUTED", + "name": "networkmode", + "type": "string" + }, { "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", "name": "domain", "type": "string" }, - {}, { - "description": "the name of the vpc offering", - "name": "name", + "description": "true if network offering supports choosing AS numbers", + "name": "specifyasnumber", + "type": "boolean" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "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 internet protocol of the vpc offering", + "name": "internetprotocol", "type": "string" }, { - "description": "indicated if the offering can support region level vpc", - "name": "supportsregionLevelvpc", - "type": "boolean" + "description": "the routing mode for the network offering, supported types are Static or Dynamic.", + "name": "routingmode", + "type": "string" }, + {}, { - "description": "an alternate display text of the vpc offering.", - "name": "displaytext", + "description": "the name of the vpc offering", + "name": "name", "type": "string" }, { @@ -184,33 +190,45 @@ "name": "service", "response": [ { - "description": "the service provider name", - "name": "provider", + "description": "the list of capabilities", + "name": "capability", "response": [ { - "description": "services for this provider", - "name": "servicelist", - "type": "list" - }, - { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", + "description": "the capability value", + "name": "value", "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" }, { - "description": "the provider name", + "description": "the capability name", "name": "name", "type": "string" + } + ], + "type": "list" + }, + { + "description": "the service name", + "name": "name", + "type": "string" + }, + { + "description": "the service provider name", + "name": "provider", + "response": [ + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" }, { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" + "description": "services for this provider", + "name": "servicelist", + "type": "list" }, { "description": "state of the network provider", @@ -218,81 +236,64 @@ "type": "string" }, { - "description": "uuid of the network provider", - "name": "id", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "the list of capabilities", - "name": "capability", - "response": [ - { - "description": "the capability name", + "description": "the provider name", "name": "name", "type": "string" }, { - "description": "the capability value", - "name": "value", + "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", + "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 service name", - "name": "name", - "type": "string" } ], "type": "list" }, - { - "description": "Mode in which the network will operate. The valid values are NATTED and ROUTED", - "name": "networkmode", - "type": "string" - }, { "description": "true if vpc offering can be used by NSX networks only", "name": "fornsx", "type": "boolean" }, - { - "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zoneid", - "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": "true if vpc offering is default, false otherwise", - "name": "isdefault", + "description": "indicated if the offering can support region level vpc", + "name": "supportsregionLevelvpc", "type": "boolean" }, { - "description": "state of the vpc offering. Can be Disabled/Enabled", - "name": "state", + "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 zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zone", + "type": "string" + }, + { + "description": " indicates if the vpc offering supports distributed router for one-hop forwarding", + "name": "distributedvpcrouter", + "type": "boolean" + }, + { + "description": "an alternate display text of the vpc offering.", + "name": "displaytext", "type": "string" }, { @@ -300,11 +301,10 @@ "name": "id", "type": "string" }, - {}, { - "description": "the internet protocol of the vpc offering", - "name": "internetprotocol", - "type": "string" + "description": "true if vpc offering is default, false otherwise", + "name": "isdefault", + "type": "boolean" } ] }, @@ -314,39 +314,40 @@ "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": "User UUID, required for adding account from external provisioning system", "length": 255, - "name": "account", + "name": "userid", "required": false, "type": "string" }, { - "description": "Unique username.", + "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", "length": 255, - "name": "username", - "required": true, + "name": "timezone", + "required": false, "type": "string" }, { - "description": "User UUID, required for adding account from external provisioning system", + "description": "Creates the account under the specified role.", "length": 255, - "name": "userid", + "name": "roleid", + "related": "createRole,importRole,listRoles,updateRole", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "details for account used to store specific parameters", + "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": "accountdetails", + "name": "account", "required": false, - "type": "map" + "type": "string" }, { - "description": "Type of the account. Specify 0 for user, 1 for root admin, and 2 for domain admin", + "description": "Unique username.", "length": 255, - "name": "accounttype", - "required": false, - "type": "integer" + "name": "username", + "required": true, + "type": "string" }, { "description": "Network domain for the account's networks", @@ -356,19 +357,18 @@ "type": "string" }, { - "description": "Creates the user under the specified domain.", + "description": "Type of the account. Specify 0 for user, 1 for root admin, and 2 for domain admin", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", + "name": "accounttype", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", + "description": "details for account used to store specific parameters", "length": 255, - "name": "timezone", + "name": "accountdetails", "required": false, - "type": "string" + "type": "map" }, { "description": "Account UUID, required for adding account from external provisioning system", @@ -378,70 +378,89 @@ "type": "string" }, { - "description": "Creates the account under the specified role.", + "description": "Creates the user under the specified domain.", "length": 255, - "name": "roleid", - "related": "createRole,importRole,listRoles,updateRole", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", "required": false, "type": "uuid" } ], "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", + "description": "the total number of public ip addresses available for this account to acquire", + "name": "ipavailable", "type": "string" }, { - "description": "the total number of cpu cores the account can own", - "name": "cpulimit", - "type": "string" + "description": "The tagged resource limit and count for the account", + "name": "taggedresources", + "type": "list" }, { - "description": "the total memory (in MB) the account can own", - "name": "memorylimit", + "description": "the total number of backups available to this account", + "name": "backupavailable", "type": "string" }, { - "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", - "name": "roletype", + "description": "the total primary storage space (in GiB) owned by account", + "name": "primarystoragetotal", + "type": "long" + }, + { + "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 id of the account", + "name": "id", "type": "string" }, { - "description": "the total number of virtual machines available for this account to acquire", - "name": "vmavailable", + "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 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 total memory (in MB) owned by account", + "name": "memorytotal", + "type": "long" }, { - "description": "the total number of buckets stored by this account", - "name": "buckettotal", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", "type": "long" }, { - "description": "the total primary storage space (in GiB) available to be used for this account", - "name": "primarystorageavailable", + "description": "the total number of networks available to be created for this account", + "name": "networkavailable", "type": "string" }, { - "description": "the total number of backups available to this account", - "name": "backupavailable", + "description": "the total primary storage space (in GiB) the account can own", + "name": "primarystoragelimit", "type": "string" }, { - "description": "the total object storage space (in GiB) available to the account", - "name": "objectstorageavailable", + "description": "the total number of networks the account can own", + "name": "networklimit", "type": "string" }, { @@ -450,24 +469,60 @@ "type": "string" }, { - "description": "true if the account requires cleanup", - "name": "iscleanuprequired", - "type": "boolean" + "description": "the total number of buckets available to this account", + "name": "bucketavailable", + "type": "string" + }, + { + "description": "the default zone of the account", + "name": "defaultzoneid", + "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) owned by account", + "name": "secondarystoragetotal", + "type": "float" + }, + { + "description": "details for the account", + "name": "accountdetails", + "type": "map" + }, + { + "description": "the total volume available for this account", + "name": "volumeavailable", + "type": "string" }, + {}, { "description": "the total number of 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": "path of the Domain the account belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the total number of gpus owned by account", - "name": "gputotal", - "type": "long" + "description": "the total number of templates which can be created by this account", + "name": "templatelimit", + "type": "string" + }, + { + "description": "true if the account requires cleanup", + "name": "iscleanuprequired", + "type": "boolean" + }, + { + "description": "the name of the role", + "name": "rolename", + "type": "string" }, { "description": "the ID of the role", @@ -475,123 +530,194 @@ "type": "string" }, { - "description": "the total primary storage space (in GiB) the account can own", - "name": "primarystoragelimit", + "description": "the total volume which can be used by this account", + "name": "volumelimit", "type": "string" }, { - "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) owned by the account", - "name": "objectstoragetotal", + "description": "the total number of virtual machines deployed by this account", + "name": "vmtotal", "type": "long" }, { - "description": "the total number of snapshots which can be stored by this account", - "name": "snapshotlimit", + "description": "the total object storage space (in GiB) available to the account", + "name": "objectstorageavailable", "type": "string" }, { - "description": "name of the Domain the account belongs to", - "name": "domain", + "description": "the total number of cpu cores the account can own", + "name": "cpulimit", "type": "string" }, { - "description": "the total number of networks the account can own", - "name": "networklimit", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the total number of gpus the account can own", - "name": "gpulimit", + "description": "the total number of backups which can be stored by this account", + "name": "backuplimit", "type": "string" }, { - "description": "the total number of vpcs the account can own", - "name": "vpclimit", + "description": "the total memory (in MB) the account can own", + "name": "memorylimit", "type": "string" }, { - "description": "the total volume available for this account", - "name": "volumeavailable", + "description": "the total number of projects being administrated by this account", + "name": "projecttotal", + "type": "long" + }, + { + "description": "the total secondary storage space (in GiB) available to be used for this account", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "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", "type": "string" }, { - "description": "the total memory (in MB) owned by account", - "name": "memorytotal", + "description": "the total number of virtual machines running for this account", + "name": "vmrunning", + "type": "integer" + }, + { + "description": "the total number of vpcs owned by account", + "name": "vpctotal", "type": "long" }, { - "description": "the total number of virtual machines deployed by this account", - "name": "vmtotal", + "description": "the network domain", + "name": "networkdomain", + "type": "string" + }, + { + "description": "the total number of backups stored by this account", + "name": "backuptotal", "type": "long" }, + { + "description": "the name of the account", + "name": "name", + "type": "string" + }, + { + "description": "the state of the account", + "name": "state", + "type": "string" + }, + { + "description": "the total number of virtual machines stopped for this account", + "name": "vmstopped", + "type": "integer" + }, + { + "description": "the 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", "type": "string" }, { - "description": "the total number of templates available to be created by this account", - "name": "templateavailable", + "description": "the list of acl groups that account belongs to", + "name": "groups", + "type": "list" + }, + {}, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "the total secondary storage space (in GiB) the account can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "the total number of networks owned by account", + "name": "networktotal", "type": "long" }, { - "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", + "name": "vmlimit", + "type": "string" }, { - "description": "account type (admin, domain-admin, user)", - "name": "accounttype", - "type": "integer" + "description": "the total number of snapshots which can be stored by this account", + "name": "snapshotlimit", + "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by account", - "name": "primarystoragetotal", + "description": "the total object storage space (in GiB) owned by the account", + "name": "objectstoragetotal", "type": "long" }, { - "description": "the name of the role", - "name": "rolename", + "description": "the total backup storage space (in GiB) available to the account", + "name": "backupstorageavailable", "type": "string" }, { - "description": "the total number of cpu cores owned by account", - "name": "cputotal", + "description": "the total number of cpu cores available to be created for this account", + "name": "cpuavailable", + "type": "string" + }, + { + "description": "the total number of gpus the account can own", + "name": "gpulimit", + "type": "string" + }, + { + "description": "the total number of vpcs the account can own", + "name": "vpclimit", + "type": "string" + }, + { + "description": "the total number of buckets stored by this account", + "name": "buckettotal", "type": "long" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "id of the Domain the account belongs to", + "name": "domainid", "type": "string" }, { - "description": "the default zone of the account", - "name": "defaultzoneid", + "description": "the total number of projects available for administration by this account", + "name": "projectavailable", "type": "string" }, { - "description": "the total number of virtual machines stopped for this account", - "name": "vmstopped", - "type": "integer" + "description": "the total object storage space (in GiB) the account can own", + "name": "objectstoragelimit", + "type": "string" }, { - "description": "the total memory (in MB) available to be created for this account", - "name": "memoryavailable", + "description": "the total number of projects the account can own", + "name": "projectlimit", + "type": "string" + }, + { + "description": "the total backup storage space (in GiB) the account can own", + "name": "backupstoragelimit", "type": "string" }, { @@ -599,18 +725,13 @@ "name": "user", "response": [ { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", - "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 account name of the user", - "name": "account", + "description": "the secret key of the user", + "name": "secretkey", "type": "string" }, { @@ -619,38 +740,38 @@ "type": "string" }, { - "description": "the type of the role", - "name": "roletype", + "description": "the name of the role", + "name": "rolename", "type": "string" }, { - "description": "the user firstname", - "name": "firstname", + "description": "the domain name of the user", + "name": "domain", "type": "string" }, { - "description": "the user lastname", - "name": "lastname", + "description": "the account ID of the user", + "name": "accountid", "type": "string" }, { - "description": "the timezone user was created in", - "name": "timezone", - "type": "string" + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" }, { - "description": "the user ID", - "name": "id", + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", "type": "string" }, { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", - "type": "boolean" + "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" }, { @@ -659,13 +780,8 @@ "type": "boolean" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the name of the role", - "name": "rolename", + "description": "the domain ID of the user", + "name": "domainid", "type": "string" }, { @@ -673,239 +789,123 @@ "name": "username", "type": "string" }, + { + "description": "the user firstname", + "name": "firstname", + "type": "string" + }, + { + "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", + "name": "apikeyaccess", + "type": "apikeyaccess" + }, { "description": "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": "the date and time the user account was created", "name": "created", "type": "date" }, { - "description": "the account ID of the user", - "name": "accountid", + "description": "the user email address", + "name": "email", + "type": "string" + }, + { + "description": "the account name of the user", + "name": "account", "type": "string" }, + { + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", + "type": "boolean" + }, { "description": "true if user has two factor authentication enabled", "name": "is2faenabled", "type": "boolean" }, { - "description": "the secret key of the user", - "name": "secretkey", + "description": "the timezone user was created in", + "name": "timezone", "type": "string" }, { - "description": "the api key of the user", - "name": "apikey", + "description": "the user lastname", + "name": "lastname", "type": "string" }, - { - "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", - "name": "apikeyaccess", - "type": "apikeyaccess" - }, { "description": "the ID of the role", "name": "roleid", "type": "string" - }, - { - "description": "the domain ID of the user", - "name": "domainid", - "type": "string" - }, - { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" } ], "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", - "type": "string" - }, - { - "description": "the total secondary storage space (in GiB) owned by account", - "name": "secondarystoragetotal", - "type": "float" - }, - { - "description": "the total backup storage space (in GiB) available to the account", - "name": "backupstorageavailable", - "type": "string" - }, - { - "description": "the total number of virtual machines running for this account", - "name": "vmrunning", - "type": "integer" - }, - { - "description": "the total backup storage space (in GiB) the account can own", - "name": "backupstoragelimit", - "type": "string" - }, - { - "description": "the name of the account", - "name": "name", - "type": "string" - }, - { - "description": "the date when this account was created", - "name": "created", - "type": "date" - }, - { - "description": "the total number of public ip addresses this account can acquire", - "name": "iplimit", - "type": "string" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "path of the Domain the account belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the total number of public ip addresses allocated for this account", - "name": "iptotal", - "type": "long" - }, - { - "description": "the total volume which can be used by this account", - "name": "volumelimit", - "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 object storage space (in GiB) the account can own", - "name": "objectstoragelimit", + "description": "the total number of templates available to be created by this account", + "name": "templateavailable", "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 gpus owned by account", + "name": "gputotal", "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 type of the role (Admin, ResourceAdmin, DomainAdmin, User)", + "name": "roletype", "type": "string" }, { - "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", + "description": "the total number of snapshots stored by this account", + "name": "snapshottotal", "type": "long" }, { - "description": "the total number of vpcs owned by account", - "name": "vpctotal", + "description": "the total backup storage space (in GiB) owned by the account", + "name": "backupstoragetotal", "type": "long" }, { - "description": "the total number of buckets available to this account", - "name": "bucketavailable", - "type": "string" - }, - { - "description": "the total number of cpu cores available to be created for this account", - "name": "cpuavailable", - "type": "string" - }, - { - "description": "the id of the account", - "name": "id", - "type": "string" - }, - { - "description": "the total number of virtual machines that can be deployed by this account", - "name": "vmlimit", + "description": "the total number of public ip addresses this account can acquire", + "name": "iplimit", "type": "string" }, - { - "description": "the total number of 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", + "description": "the total volume being used by this account", + "name": "volumetotal", "type": "long" }, { - "description": "the state of the account", - "name": "state", - "type": "string" - }, - { - "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", - "name": "apikeyaccess", - "type": "apikeyaccess" - }, - { - "description": "the total number of templates which can be created by this account", - "name": "templatelimit", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the total number of projects being administrated by this account", - "name": "projecttotal", + "description": "the total number of templates which have been created by this account", + "name": "templatetotal", "type": "long" - }, - { - "description": "id of the Domain the account belongs to", - "name": "domainid", - "type": "string" } ], "since": "4.2.0" @@ -915,14 +915,6 @@ "isasync": true, "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.", - "length": 255, - "name": "destzoneids", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "list" - }, { "description": "ID of the zone the template is being copied to.", "length": 255, @@ -935,10 +927,18 @@ "description": "Template ID.", "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", + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,copyIso,listIsos,registerIso,updateIso,copyTemplate,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", "required": true, "type": "uuid" }, + { + "description": "A list of IDs of the zones that the template needs to be copied to.Specify this list if the template needs to copied to multiple zones in one go. Do not specify destzoneid and destzoneids together, however one of them is required.", + "length": 255, + "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.", "length": 255, @@ -948,78 +948,47 @@ "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 the ISO is bootable, false otherwise", - "name": "bootable", - "type": "boolean" - }, - { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", "type": "boolean" }, - {}, { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", "type": "boolean" }, - { - "description": "the date this template was removed", - "name": "removed", - "type": "date" - }, - { - "description": "the account id to which the template belongs", - "name": "accountid", - "type": "string" - }, { "description": "the template ID of the parent template if present", "name": "sourcetemplateid", "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 physical size of the template", - "name": "physicalsize", - "type": "long" - }, - { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", + "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 the secondary storage host for the template", - "name": "hostid", + "description": "the id of userdata linked to this template", + "name": "userdataid", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", + "type": "boolean" }, { - "description": "the ID of the zone for this template", - "name": "zoneid", - "type": "string" + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", + "type": "boolean" }, { "description": "the name of the secondary storage host for the template", @@ -1027,54 +996,45 @@ "type": "string" }, { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", - "type": "string" - }, - { - "description": "the project id of the template", - "name": "projectid", + "description": "the project name of the template", + "name": "project", "type": "string" }, { - "description": "the template ID", - "name": "id", - "type": "string" + "description": "the size of the template", + "name": "size", + "type": "long" }, { - "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", - "name": "userdataparams", + "description": "the UUID of the latest async 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": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", - "type": "string" + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", + "type": "boolean" }, + {}, { - "description": "the name of the OS type for this template.", - "name": "ostypename", - "type": "string" + "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 reset password feature is enabled, false otherwise", - "name": "passwordenabled", + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", "type": "boolean" }, { - "description": "The name of extension linked to this template", - "name": "extensionname", + "description": "CPU Arch of the template", + "name": "arch", "type": "string" }, { - "description": "the size of the template", - "name": "size", - "type": "long" + "description": "the project id of the template", + "name": "projectid", + "type": "string" }, { "description": "the processor bit size", @@ -1082,223 +1042,263 @@ "type": "int" }, { - "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 URL which the template/iso is registered from", - "name": "url", + "description": "the type of the template", + "name": "templatetype", "type": "string" }, - {}, { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", - "type": "boolean" + "description": "the format of the template.", + "name": "format", + "type": "imageformat" }, { - "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": "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 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": "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 secondary storage host for the template", + "name": "hostid", + "type": "string" + }, + { + "description": "the physical size of the template", + "name": "physicalsize", + "type": "long" + }, + { + "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 tag of this template", - "name": "templatetag", + "description": "the template display text", + "name": "displaytext", "type": "string" }, { - "description": "the id of userdata linked to this template", - "name": "userdataid", + "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 status of the template", - "name": "status", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "The ID of extension linked to this template", - "name": "extensionid", + "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", - "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 name", + "name": "name", "type": "string" }, { - "description": "the project name of the template", - "name": "project", + "description": "the name of the OS type for this template.", + "name": "ostypename", "type": "string" }, { - "description": "the account name to which the template belongs", - "name": "account", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the ID of the OS type for this template.", + "name": "ostypeid", "type": "string" }, { - "description": "path of the Domain the template belongs to", - "name": "domainpath", + "description": "the name of the domain to which the template belongs", + "name": "domain", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "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": "true if the template is extractable, false otherwise", + "name": "isextractable", "type": "boolean" }, { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", - "type": "boolean" + "description": "the status of the template", + "name": "status", + "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the ID of the domain to which the template belongs", + "name": "domainid", "type": "string" }, { - "description": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", - "type": "set" + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "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 name of userdata linked to this template", + "name": "userdataname", + "type": "string" }, { - "description": "the template name", - "name": "name", - "type": "string" + "description": "the date this template was removed", + "name": "removed", + "type": "date" }, { - "description": "the template display text", - "name": "displaytext", + "description": "the template ID", + "name": "id", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the date this template was created", + "name": "created", + "type": "date" }, { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the name of the domain to which the template belongs", - "name": "domain", + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "the name of the zone for this template", + "name": "zonename", "type": "string" }, { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "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": "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": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", + "description": "the ID of the zone for this template", + "name": "zoneid", + "type": "string" + }, + { + "description": "If true it indicates that the template can be used for CKS cluster deployments", + "name": "forcks", "type": "boolean" }, { - "description": "the type of the template", - "name": "templatetype", + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" + }, + { + "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": "resource type", + "name": "resourcetype", + "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" + }, + { + "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": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the tag of this template", + "name": "templatetag", "type": "string" }, { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" + "description": "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.", @@ -1322,17 +1322,17 @@ } ], "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, {}, { "description": "any text associated with the success or failure", @@ -1358,14 +1358,6 @@ "required": false, "type": "integer" }, - { - "description": "ID of the storage policy", - "length": 255, - "name": "policyid", - "related": "importVsphereStoragePolicies,listVsphereStoragePolicies", - "required": false, - "type": "uuid" - }, { "description": "", "length": 255, @@ -1374,11 +1366,12 @@ "type": "integer" }, { - "description": "List by keyword", + "description": "ID of the storage policy", "length": 255, - "name": "keyword", + "name": "policyid", + "related": "importVsphereStoragePolicies,listVsphereStoragePolicies", "required": false, - "type": "string" + "type": "uuid" }, { "description": "ID of the zone", @@ -1387,59 +1380,88 @@ "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "uuid" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" } ], "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", "response": [ + {}, { - "description": "the nfs mount options for the storage pool", - "name": "nfsmountopts", + "description": "the pool'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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the Pod name of the storage pool", + "name": "podname", "type": "string" }, { - "description": "the storage pool details", - "name": "details", + "description": "the storage pool capabilities", + "name": "storagecapabilities", "type": "map" }, { - "description": "total min IOPS currently in use by volumes", - "name": "allocatediops", + "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": "total IOPS currently in use", + "name": "usediops", + "type": "long" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", - "type": "long" + "description": "the hypervisor type of the storage pool", + "name": "hypervisor", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the scope of the storage pool", + "name": "scope", + "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": "whether this pool is managed or not", - "name": "managed", - "type": "boolean" - }, { "description": "the state of the storage pool", "name": "state", "type": "storagepoolstatus" }, { - "description": "the name of the cluster for the storage pool", - "name": "clustername", - "type": "string" + "description": "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 name of the storage pool", @@ -1447,60 +1469,54 @@ "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 Zone name of the storage pool", - "name": "zonename", - "type": "string" + "description": "the date and time the storage pool was created", + "name": "created", + "type": "date" }, - {}, { - "description": "the tags for the storage pool", - "name": "tags", + "description": "the name of the cluster for the storage pool", + "name": "clustername", "type": "string" }, { - "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": "the total disk size of the storage pool", - "name": "disksizetotal", - "type": "long" + "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": "whether this pool is managed or not", + "name": "managed", "type": "boolean" }, { - "description": "IOPS CloudStack can provision from this storage pool", - "name": "capacityiops", - "type": "long" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the storage pool path", + "name": "path", + "type": "string" }, { - "description": "the Zone ID of the storage pool", - "name": "zoneid", + "description": "the storage pool type", + "name": "type", "type": "string" }, { - "description": "total IOPS currently in use", - "name": "usediops", - "type": "long" + "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": "the storage pool details", + "name": "details", + "type": "map" }, { "description": "the UUID of the latest async job acting on this object", @@ -1508,64 +1524,53 @@ "type": "string" }, { - "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 Zone name of the storage pool", + "name": "zonename", "type": "string" }, - { - "description": "the storage pool capabilities", - "name": "storagecapabilities", - "type": "map" - }, - { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" - }, - {}, { "description": "the Pod ID of the storage pool", "name": "podid", "type": "string" }, { - "description": "the ID of the storage pool", - "name": "id", - "type": "string" + "description": "bytes CloudStack can provision from this storage pool", + "name": "capacitybytes", + "type": "long" }, { - "description": "the IP address of the storage pool", - "name": "ipaddress", - "type": "string" + "description": "the total disk size of the storage pool", + "name": "disksizetotal", + "type": "long" }, { - "description": "the Pod name of the storage pool", - "name": "podname", + "description": "the nfs mount options for the storage pool", + "name": "nfsmountopts", "type": "string" }, { - "description": "the storage pool path", - "name": "path", + "description": "the Zone ID of the storage pool", + "name": "zoneid", "type": "string" }, { - "description": "the overprovisionfactor for the storage pool", - "name": "overprovisionfactor", + "description": "the ID of the storage pool", + "name": "id", "type": "string" }, { - "description": "the hypervisor type of the storage pool", - "name": "hypervisor", + "description": "the tags for the storage pool", + "name": "tags", "type": "string" }, { - "description": "Storage provider for this pool", - "name": "provider", + "description": "the overprovisionfactor for the storage pool", + "name": "overprovisionfactor", "type": "string" } ] @@ -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,6 +1587,14 @@ "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", @@ -1599,50 +1604,51 @@ "name": "arch", "type": "string" }, + {}, { - "description": "the template ID for the system VM", - "name": "templateid", + "description": "the public MAC address for the system VM", + "name": "publicmacaddress", "type": "string" }, { - "description": "the private IP address for the system VM", - "name": "privateip", + "description": "the ID of the system VM", + "name": "id", "type": "string" }, { - "description": "the host ID for the system VM", - "name": "hostid", + "description": "the link local MAC address for the system vm", + "name": "linklocalmacaddress", "type": "string" }, { - "description": "the template name for the system VM", - "name": "templatename", + "description": "the first DNS for the system VM", + "name": "dns1", "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 hypervisor on which the template runs", - "name": "hypervisor", + "description": "the host ID for the system VM", + "name": "hostid", "type": "string" }, { - "description": "the gateway for the system VM", - "name": "gateway", + "description": "the Pod ID for the system VM", + "name": "podid", "type": "string" }, { - "description": "the state of the system VM", - "name": "state", + "description": "the systemvm agent version", + "name": "version", "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "the date and time the system VM was created", + "name": "created", + "type": "date" }, { "description": "the Zone name for the system VM", @@ -1650,156 +1656,155 @@ "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 name of the service offering of the system virtual machine.", + "name": "serviceofferingname", "type": "string" }, { - "description": "the Pod ID for the system VM", - "name": "podid", + "description": "the control state of the host for the system VM", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the Pod name for the system VM", - "name": "podname", + "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 system VM type", + "name": "systemvmtype", "type": "string" }, { - "description": "the name of the service offering of the system virtual machine.", - "name": "serviceofferingname", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the public netmask for the system VM", - "name": "publicnetmask", + "description": "the gateway for the system VM", + "name": "gateway", "type": "string" }, { - "description": "the second DNS for the system VM", - "name": "dns2", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the network domain for the system VM", - "name": "networkdomain", + "description": "the number of active console sessions for the console proxy system vm", + "name": "activeviewersessions", + "type": "integer" + }, + { + "description": "the ID of the service offering of the system virtual machine.", + "name": "serviceofferingid", "type": "string" }, { - "description": "the private MAC address for the system VM", - "name": "privatemacaddress", + "description": "the public IP address for the system VM", + "name": "publicip", "type": "string" }, { - "description": "the first DNS for the system VM", - "name": "dns1", + "description": "the second DNS for the system VM", + "name": "dns2", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the template name for the system VM", + "name": "templatename", + "type": "string" }, - {}, { "description": "guest vlan range", "name": "guestvlan", "type": "string" }, { - "description": "the hostname for the system VM", - "name": "hostname", + "description": "the private netmask for the system VM", + "name": "privatenetmask", "type": "string" }, { - "description": "the agent state of the system VM", - "name": "agentstate", + "description": "the template ID for the system VM", + "name": "templateid", "type": "string" }, { - "description": "the link local MAC address for the system vm", - "name": "linklocalmacaddress", + "description": "the private MAC address for the system VM", + "name": "privatemacaddress", "type": "string" }, { - "description": "the control state of the host for the system VM", - "name": "hostcontrolstate", + "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": "the public netmask for the system VM", + "name": "publicnetmask", + "type": "string" }, { - "description": "the link local netmask for the system vm", - "name": "linklocalnetmask", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "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 ID of the system VM", - "name": "id", + "description": "the link local netmask for the system vm", + "name": "linklocalnetmask", "type": "string" }, { - "description": "the date and time the system VM was created", - "name": "created", - "type": "date" + "description": "the network domain for the system VM", + "name": "networkdomain", + "type": "string" }, { "description": "public vlan range", "name": "publicvlan", "type": "list" }, + {}, { - "description": "the public MAC address for the system VM", - "name": "publicmacaddress", + "description": "the private IP address for the system VM", + "name": "privateip", "type": "string" }, - { - "description": "the last disconnected date of host", - "name": "disconnected", - "type": "date" - }, { "description": "the link local IP address for the system vm", "name": "linklocalip", "type": "string" }, - {}, { - "description": "the name of the system VM", - "name": "name", - "type": "string" + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "the systemvm agent version", - "name": "version", + "description": "the hostname for the system VM", + "name": "hostname", "type": "string" }, { - "description": "the public IP address for the system VM", - "name": "publicip", + "description": "the agent state of the system VM", + "name": "agentstate", "type": "string" }, { - "description": "the private netmask for the system VM", - "name": "privatenetmask", - "type": "string" + "description": "the last disconnected date of host", + "name": "disconnected", + "type": "date" } ] }, @@ -1809,27 +1814,26 @@ "name": "listDedicatedZones", "params": [ { - "description": "the ID of the Zone", + "description": "", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "list dedicated zones by affinity group", + "description": "List by keyword", "length": 255, - "name": "affinitygroupid", - "related": "createAffinityGroup,listAffinityGroups", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "", + "description": "the ID of the domain associated with the zone", "length": 255, - "name": "pagesize", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", "required": false, - "type": "integer" + "type": "uuid" }, { "description": "", @@ -1839,59 +1843,56 @@ "type": "integer" }, { - "description": "the ID of the domain associated with the zone", + "description": "list dedicated zones by affinity group", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", + "name": "affinitygroupid", + "related": "createAffinityGroup,listAffinityGroups", "required": false, "type": "uuid" }, { - "description": "List by keyword", + "description": "the name of the account associated with the zone. Must be used with domainId.", "length": 255, - "name": "keyword", + "name": "account", "required": false, "type": "string" }, { - "description": "the name of the account associated with the zone. Must be used with domainId.", + "description": "the ID of the Zone", "length": 255, - "name": "account", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "string" + "type": "uuid" } ], "related": "dedicateZone", "response": [ { - "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 domain ID to which the Zone is dedicated", + "name": "domainid", "type": "string" }, {}, { - "description": "the Account Id to which the Zone is dedicated", - "name": "accountid", + "description": "the ID of the Zone", + "name": "zoneid", "type": "string" }, { - "description": "the ID of the Zone", - "name": "zoneid", + "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 Account Id to which the Zone is dedicated", + "name": "accountid", + "type": "string" }, + {}, { - "description": "the domain ID to which the Zone is dedicated", - "name": "domainid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -1899,11 +1900,15 @@ "name": "affinitygroupid", "type": "string" }, - {}, { - "description": "the ID of the dedicated resource", - "name": "id", + "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" } ] }, @@ -1922,52 +1927,52 @@ ], "related": "", "response": [ + { + "description": "the ID of the storage pool", + "name": "id", + "type": "string" + }, + {}, { "description": "available iops of the pool", "name": "maxiops", "type": "long" }, - { - "description": "the name of the storage pool", - "name": "name", - "type": "string" - }, { "description": "the current available space of the pool", "name": "size", "type": "long" }, + {}, { - "description": "controller of the pool", - "name": "controllerid", + "description": "the state of the storage pool", + "name": "state", "type": "string" }, { - "description": "the ID of the storage pool", - "name": "id", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "controller of the pool", + "name": "controllerid", "type": "string" }, - {}, { - "description": "the state of the storage pool", - "name": "state", + "description": "default gateway of the pool", + "name": "gateway", "type": "string" }, { - "description": "default gateway of the pool", - "name": "gateway", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the name of the storage pool", + "name": "name", + "type": "string" } ] }, @@ -1995,6 +2000,27 @@ ], "related": "createBgpPeer,listBgpPeers,updateBgpPeer,dedicateBgpPeer,releaseBgpPeer,changeBgpPeersForVpc", "response": [ + { + "description": "the project id of the bgp peer", + "name": "projectid", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, + { + "description": "id of zone to which the bgp peer belongs to.", + "name": "zoneid", + "type": "string" + }, + { + "description": "id of the bgp peer", + "name": "id", + "type": "string" + }, {}, { "description": "the current status of the latest async job acting on this object", @@ -2007,9 +2033,9 @@ "type": "long" }, { - "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 name of the bgp peer", @@ -2022,8 +2048,13 @@ "type": "string" }, { - "description": "the project id of the bgp peer", - "name": "projectid", + "description": "the account of the bgp peer", + "name": "account", + "type": "string" + }, + { + "description": "name of zone to which the bgp peer belongs to.", + "name": "zonename", "type": "string" }, { @@ -2032,50 +2063,24 @@ "type": "map" }, { - "description": "password of bgp peer", - "name": "password", + "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 project name of the bgp peer", "name": "project", "type": "string" }, { - "description": "id of zone to which the bgp peer belongs to.", - "name": "zoneid", - "type": "string" - }, - { - "description": "the account of the bgp peer", - "name": "account", + "description": "password of bgp peer", + "name": "password", "type": "string" }, { "description": "IPv4 address of bgp peer", "name": "ipaddress", "type": "string" - }, - { - "description": "id of the bgp peer", - "name": "id", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the domain ID of the bgp peer", - "name": "domainid", - "type": "string" } ], "since": "4.20.0" @@ -2099,54 +2104,48 @@ "required": false, "type": "string" }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, { "description": "the ID of lb rule", "length": 255, "name": "lbruleid", - "related": "createRoutingFirewallRule,listRoutingFirewallRules,updateRoutingFirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule", + "related": "createRoutingFirewallRule,listRoutingFirewallRules,updateRoutingFirewallRule,createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules", "required": true, "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" } ], "related": "updateTungstenFabricLBHealthMonitor", "response": [ { - "description": "the health monitor timeout", - "name": "timeout", + "description": "the health monitor interval", + "name": "interval", "type": "int" }, - { - "description": "the health monitor url path", - "name": "urlpath", - "type": "string" - }, { "description": "Tungsten-Fabric provider zone id", "name": "zoneid", "type": "long" }, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "the health monitor UUID", + "name": "uuid", "type": "string" }, - {}, { - "description": "the health monitor UUID", - "name": "uuid", + "description": "the health monitor http method", + "name": "httpmethod", "type": "string" }, { - "description": "the health monitor ID", - "name": "id", - "type": "long" + "description": "the health monitor url path", + "name": "urlpath", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", @@ -2154,40 +2153,46 @@ "type": "integer" }, { - "description": "the health monitor retry", - "name": "retry", - "type": "int" - }, - { - "description": "the health monitor expected code", - "name": "expectedcode", + "description": "the health monitor type", + "name": "type", "type": "string" }, { - "description": "the health monitor type", - "name": "type", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, { - "description": "the health monitor interval", - "name": "interval", - "type": "int" + "description": "the health monitor ID", + "name": "id", + "type": "long" }, {}, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + { + "description": "the health monitor retry", + "name": "retry", + "type": "int" + }, + { + "description": "the health monitor expected code", + "name": "expectedcode", + "type": "string" + }, { "description": "the LB rule ID", "name": "lbruleid", "type": "string" }, { - "description": "the health monitor http method", - "name": "httpmethod", - "type": "string" + "description": "the health monitor timeout", + "name": "timeout", + "type": "int" } ] }, @@ -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,createVMFromBackup,createVMFromBackup,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", "required": true, "type": "list" }, @@ -2215,30 +2220,25 @@ ], "related": "createKubernetesCluster,startKubernetesCluster,listKubernetesClusters,scaleKubernetesCluster,upgradeKubernetesCluster,addNodesToKubernetesCluster", "response": [ + { + "description": "the control nodes count for the Kubernetes cluster", + "name": "controlnodes", + "type": "long" + }, { "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 name of the service offering of the control nodes on the Kubernetes cluster", - "name": "controlofferingname", + "description": "the name of the service offering of the worker nodes on the Kubernetes cluster", + "name": "workerofferingname", "type": "string" }, { - "description": "Minimum size of the cluster", - "name": "minsize", - "type": "long" - }, - { - "description": "Maximum size of the cluster", - "name": "maxsize", - "type": "long" + "description": "ID of CNI Configuration associated with the cluster", + "name": "cniconfigurationid", + "type": "string" }, { "description": "Public IP Addresses of the etcd nodes", @@ -2246,50 +2246,39 @@ "type": "map" }, { - "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", + "description": "Minimum size of the cluster", + "name": "minsize", "type": "long" }, { - "description": "keypair details", - "name": "keypair", + "description": "path of the domain to which the Kubernetes cluster belongs", + "name": "domainpath", "type": "string" }, { - "description": "the id of the Kubernetes cluster", - "name": "id", + "description": "the name of the zone of the Kubernetes cluster", + "name": "zoneid", "type": "string" }, { - "description": "the ID of the service offering of the control nodes on the Kubernetes cluster", - "name": "controlofferingid", + "description": "the name of the domain in which the Kubernetes cluster exists", + "name": "domain", "type": "string" }, { - "description": "the memory the Kubernetes cluster", - "name": "memory", + "description": "Name of CNI Configuration associated with the cluster", + "name": "cniconfigname", "type": "string" }, { - "description": "Whether autoscaling is enabled for the cluster", - "name": "autoscalingenabled", - "type": "boolean" + "description": "Public IP Address of the cluster", + "name": "ipaddress", + "type": "string" }, { "description": "URL end point for the Kubernetes cluster dashboard UI", @@ -2297,18 +2286,14 @@ "type": "string" }, { - "description": "the project id of the Kubernetes cluster", - "name": "projectid", + "description": "the description of the Kubernetes cluster", + "name": "description", "type": "string" }, + {}, { - "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", + "description": "the ID of the service offering of the worker nodes on the Kubernetes cluster", + "name": "workerofferingid", "type": "string" }, { @@ -2317,18 +2302,13 @@ "type": "string" }, { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zoneid", - "type": "string" - }, - { - "description": "the name of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionname", + "description": "the name of the service offering of the control nodes on the Kubernetes cluster", + "name": "controlofferingname", "type": "string" }, { - "description": "Name of CNI Configuration associated with the cluster", - "name": "cniconfigname", + "description": "URL end point for the Kubernetes cluster", + "name": "endpoint", "type": "string" }, { @@ -2337,23 +2317,39 @@ "type": "integer" }, { - "description": "the name of the service offering of the etcd nodes on the Kubernetes cluster", - "name": "etcdofferingname", + "description": "the ID of the network of the Kubernetes cluster", + "name": "networkid", "type": "string" }, + {}, { - "description": "the project name of the Kubernetes cluster", - "name": "project", + "description": "the cpu cores of the Kubernetes cluster", + "name": "cpunumber", "type": "string" }, { - "description": "the ID of the service offering of the etcd nodes on the Kubernetes cluster", - "name": "etcdofferingid", + "description": "keypair details", + "name": "keypair", "type": "string" }, { - "description": "the ID of the domain in which the Kubernetes cluster exists", - "name": "domainid", + "description": "Public IP Address ID of the cluster", + "name": "ipaddressid", + "type": "string" + }, + { + "description": "Maximum size of the cluster", + "name": "maxsize", + "type": "long" + }, + { + "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" }, { @@ -2362,18 +2358,18 @@ "type": "long" }, { - "description": "the account associated with the Kubernetes cluster", - "name": "account", - "type": "string" + "description": "the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", + "name": "masternodes", + "type": "long" }, { - "description": "Public IP Address of the cluster", - "name": "ipaddress", + "description": "the state of the Kubernetes cluster", + "name": "state", "type": "string" }, { - "description": "the name of the domain in which the Kubernetes cluster exists", - "name": "domain", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -2382,79 +2378,93 @@ "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": "URL end point for the Kubernetes cluster", - "name": "endpoint", + "description": "the ID of the service offering of the Kubernetes cluster", + "name": "serviceofferingid", "type": "string" }, { - "description": "the name of the service offering of the worker nodes on the Kubernetes cluster", - "name": "workerofferingname", + "description": "the name of the service offering of the Kubernetes cluster", + "name": "serviceofferingname", "type": "string" }, { - "description": "the type of the cluster", - "name": "clustertype", - "type": "clustertype" + "description": "the name of the zone of the Kubernetes cluster", + "name": "zonename", + "type": "string" }, { - "description": "Public IP Address ID of the cluster", - "name": "ipaddressid", - "type": "string" + "description": "Whether autoscaling is enabled for the cluster", + "name": "autoscalingenabled", + "type": "boolean" }, { - "description": "ID of CNI Configuration associated with the cluster", - "name": "cniconfigurationid", + "description": "the account associated with the Kubernetes cluster", + "name": "account", "type": "string" }, { - "description": "the ID of the service offering of the worker nodes on the Kubernetes cluster", - "name": "workerofferingid", + "description": "the ID of the domain in which the Kubernetes cluster exists", + "name": "domainid", "type": "string" }, { - "description": "the ID of the service offering of the Kubernetes cluster", - "name": "serviceofferingid", + "description": "the memory the Kubernetes cluster", + "name": "memory", "type": "string" }, { - "description": "path of the domain to which the Kubernetes cluster belongs", - "name": "domainpath", + "description": "the id of the Kubernetes cluster", + "name": "id", "type": "string" }, { - "description": "the description of the Kubernetes cluster", - "name": "description", + "description": "the name of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionname", "type": "string" }, { - "description": "the ID of the network of the Kubernetes cluster", - "name": "networkid", + "description": "the ID of the service offering of the control nodes on the Kubernetes cluster", + "name": "controlofferingid", "type": "string" }, - {}, + { + "description": "the list of virtualmachine associated with this Kubernetes cluster", + "name": "virtualmachines", + "type": "list" + }, { "description": "the number of the etcd nodes on the Kubernetes cluster", "name": "etcdnodes", "type": "long" }, { - "description": "the state of the Kubernetes cluster", - "name": "state", + "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": "Indicates if the CloudStack CSI driver has been setup in the cluster", + "name": "csienabled", + "type": "boolean" + }, { "description": "the date when this Kubernetes cluster was created", "name": "created", "type": "date" }, { - "description": "the cpu cores of the Kubernetes cluster", - "name": "cpunumber", + "description": "the project name of the Kubernetes cluster", + "name": "project", "type": "string" } ], @@ -2465,13 +2475,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,13 +2482,20 @@ "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": "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", @@ -2500,9 +2510,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" } ], "since": "3.0.0" @@ -2512,15 +2522,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, @@ -2528,13 +2529,6 @@ "required": false, "type": "boolean" }, - { - "description": "Map of (key/value pairs)", - "length": 255, - "name": "details", - "required": false, - "type": "map" - }, { "description": "UUID of the Guest OS", "length": 255, @@ -2549,39 +2543,45 @@ "name": "osdisplayname", "required": false, "type": "string" + }, + { + "description": "Map of (key/value pairs)", + "length": 255, + "name": "details", + "required": false, + "type": "map" + }, + { + "description": "the ID of the OS category", + "length": 255, + "name": "oscategoryid", + "related": "listOsCategories,addOsCategory,updateOsCategory", + "required": false, + "since": "4.21.0", + "type": "uuid" } ], "related": "listOsTypes,addGuestOs", "response": [ - { - "description": "the ID of the OS category", - "name": "oscategoryid", - "type": "string" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "is the guest OS visible for the users", - "name": "fordisplay", - "type": "boolean" - }, { "description": "the ID of the OS type", "name": "id", "type": "string" }, + { + "description": "the ID of the OS category", + "name": "oscategoryid", + "type": "string" + }, {}, { - "description": "the name of the OS category", - "name": "oscategoryname", + "description": "the name/description of the OS type", + "name": "description", "type": "string" }, { @@ -2590,14 +2590,24 @@ "type": "boolean" }, {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the name of the OS type", "name": "name", "type": "string" }, { - "description": "the name/description of the OS type", - "name": "description", + "description": "is the guest OS visible for the users", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the name of the OS category", + "name": "oscategoryname", "type": "string" } ], @@ -2609,18 +2619,18 @@ "name": "listGuestVlans", "params": [ { - "description": "list guest vlan by vnet", + "description": "", "length": 255, - "name": "vnet", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "list guest vlan by id", + "description": "list guest vlan by vnet", "length": 255, - "name": "id", + "name": "vnet", "required": false, - "type": "long" + "type": "string" }, { "description": "list guest vlan by zone", @@ -2631,120 +2641,110 @@ "type": "uuid" }, { - "description": "", + "description": "list guest vlan by physical network", "length": 255, - "name": "pagesize", + "name": "physicalnetworkid", + "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "limits search results to allocated guest vlan. false by default.", + "description": "", "length": 255, - "name": "allocatedonly", + "name": "pagesize", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "list guest vlan by physical network", + "description": "limits search results to allocated guest vlan. false by default.", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", + "name": "allocatedonly", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "List by keyword", + "description": "list guest vlan by id", "length": 255, - "name": "keyword", + "name": "id", "required": false, - "type": "string" + "type": "long" } ], "related": "", "response": [ { - "description": "the physical network ID of the guest VLAN range", - "name": "physicalnetworkid", + "description": "the guest VLAN", + "name": "vlan", "type": "string" }, { - "description": "true if the guest VLAN is dedicated to the account", - "name": "isdedicated", - "type": "boolean" + "description": "the domain ID of the guest VLAN range", + "name": "domainid", + "type": "string" }, { - "description": "the list of networks who use this guest VLAN", - "name": "network", - "type": "list" + "description": "path of the domain to which the guest VLAN range belongs", + "name": "domainpath", + "type": "string" }, { - "description": "the guest VLAN id", - "name": "id", - "type": "long" + "description": "the domain name of the guest VLAN range", + "name": "domain", + "type": "string" }, { "description": "date the guest VLAN was taken", "name": "taken", "type": "date" }, - {}, { - "description": "the project id of the guest VLAN range", - "name": "projectid", + "description": "the zone name of the guest VLAN range", + "name": "zonename", "type": "string" }, {}, { - "description": "the guest VLAN", - "name": "vlan", + "description": "the physical network name of the guest VLAN range", + "name": "physicalnetworkname", "type": "string" }, { - "description": "path of the domain to which the guest VLAN range belongs", - "name": "domainpath", + "description": "the allocation state of the guest VLAN", + "name": "allocationstate", "type": "string" }, { - "description": "the zone name of the guest VLAN range", - "name": "zonename", - "type": "string" + "description": "the list of networks who use this guest VLAN", + "name": "network", + "type": "list" }, + {}, { "description": "the account of the guest VLAN range", "name": "account", "type": "string" }, { - "description": "the domain name of the guest VLAN range", - "name": "domain", - "type": "string" - }, - { - "description": "the allocation state of the guest VLAN", - "name": "allocationstate", - "type": "string" - }, - { - "description": "the physical network name of the guest VLAN range", - "name": "physicalnetworkname", + "description": "the physical network ID of the guest VLAN range", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project id of the guest VLAN range", + "name": "projectid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if the guest VLAN is dedicated to the account", + "name": "isdedicated", + "type": "boolean" }, { "description": "the project name of the guest VLAN range", @@ -2752,14 +2752,24 @@ "type": "string" }, { - "description": "the domain ID of the guest VLAN range", - "name": "domainid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { "description": "the zone ID of the guest VLAN range", "name": "zoneid", "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the guest VLAN id", + "name": "id", + "type": "long" } ], "since": "4.17.0" @@ -2769,21 +2779,6 @@ "isasync": false, "name": "updateResourceLimit", "params": [ - { - "description": " Maximum resource limit.", - "length": 255, - "name": "max", - "required": false, - "type": "long" - }, - { - "description": "Update resource limits for project", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", - "required": false, - "type": "uuid" - }, { "description": "Update resource limits for all accounts in specified domain. If used with the account parameter, updates resource limits for a specified account in specified domain.", "length": 255, @@ -2807,6 +2802,21 @@ "required": false, "type": "string" }, + { + "description": "Update resource limits for project", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "uuid" + }, + { + "description": " Maximum resource limit.", + "length": 255, + "name": "max", + "required": false, + "type": "long" + }, { "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, @@ -2818,66 +2828,66 @@ "related": "listResourceLimits", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "resource type. Values include 0, 1, 2, 3, 4, 6, 7, 8, 9, 10, 11. See the resourceType parameter for more information on these values.", + "name": "resourcetype", "type": "string" }, { - "description": "the maximum number of the resource. A -1 means the resource currently has no limit.", - "name": "max", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "resource type. Values include 0, 1, 2, 3, 4, 6, 7, 8, 9, 10, 11. See the resourceType parameter for more information on these values.", - "name": "resourcetype", + "description": "The tag for the resource limit", + "name": "tag", "type": "string" }, - {}, { - "description": "the domain name of the resource limit", - "name": "domain", + "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 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": "path of the domain to which the resource limit belongs", - "name": "domainpath", + "description": "the project id of the resource limit", + "name": "projectid", "type": "string" }, { - "description": "the project name of the resource limit", - "name": "project", + "description": "path of the domain to which the resource limit belongs", + "name": "domainpath", "type": "string" }, { - "description": "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 domain name of the resource limit", + "name": "domain", "type": "string" }, { - "description": "the project id of the resource limit", - "name": "projectid", + "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 tag for the resource limit", - "name": "tag", + "description": "the account of the resource limit", + "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" } ] }, @@ -2897,25 +2907,25 @@ ], "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", + "description": "The CSS to be retrieved and imported into the GUI when matching the theme access configurations.", + "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", + "description": "Whether to consider the subdomains of the informed domain IDs.", + "name": "recursivedomains", "type": "boolean" }, { - "description": "The CSS to be retrieved and imported into the GUI when matching the theme access configurations.", - "name": "css", + "description": "Description of the GUI theme.", + "name": "description", "type": "string" }, - {}, { - "description": "Name of the GUI theme.", - "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", + "name": "commonnames", "type": "string" }, { @@ -2923,10 +2933,11 @@ "name": "domainids", "type": "string" }, + {}, { - "description": "ID of the custom GUI theme.", - "name": "id", - "type": "string" + "description": "When the GUI theme was created.", + "name": "created", + "type": "date" }, { "description": "the current status of the latest async job acting on this object", @@ -2934,25 +2945,29 @@ "type": "integer" }, { - "description": "Whether to consider the subdomains of the informed domain IDs.", - "name": "recursivedomains", - "type": "boolean" + "description": "Name of the GUI theme.", + "name": "name", + "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": "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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "ID of the custom GUI theme.", + "name": "id", "type": "string" }, - {}, { - "description": "When the GUI theme was created.", - "name": "created", - "type": "date" + "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": "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.", @@ -2960,13 +2975,8 @@ "type": "date" }, { - "description": "Description of the GUI theme.", - "name": "description", - "type": "string" - }, - { - "description": "A set of Common Names (CN) (fixed or wildcard) separated by comma that can retrieve the theme; e.g.: *acme.com,acme2.com", - "name": "commonnames", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ], @@ -2987,28 +2997,28 @@ } ], "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" - } + {} ] }, { @@ -3028,31 +3038,31 @@ "related": "", "response": [ {}, - {}, - { - "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": "the UUID of the latest async 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": "chain", + "name": "chain", + "type": "string" } ] }, @@ -3071,28 +3081,28 @@ } ], "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" - } + }, + {}, + {} ] }, { @@ -3101,18 +3111,20 @@ "name": "startRollingMaintenance", "params": [ { - "description": "the command to execute while hosts are on maintenance", + "description": "the IDs of the clusters to start maintenance on", "length": 255, - "name": "payload", + "name": "clusterids", + "related": "addCluster,listClusters,updateCluster", "required": false, - "type": "string" + "type": "list" }, { - "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", @@ -3130,86 +3142,94 @@ "type": "integer" }, { - "description": "the IDs of the zones to start maintenance on", + "description": "the IDs of the hosts to start maintenance on", "length": 255, - "name": "zoneids", - "related": "createZone,updateZone,listZones,listZones", + "name": "hostids", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,updateHost", "required": false, "type": "list" }, { - "description": "the IDs of the hosts to start maintenance on", + "description": "the command to execute while hosts are on maintenance", "length": 255, - "name": "hostids", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,updateHost,addBaremetalHost", + "name": "payload", "required": false, - "type": "list" + "type": "string" }, { - "description": "the IDs of the clusters to start maintenance on", + "description": "if rolling mechanism should continue in case of an error", "length": 255, - "name": "clusterids", - "related": "addCluster,listClusters,updateCluster", + "name": "forced", "required": false, - "type": "list" + "type": "boolean" } ], "related": "", "response": [ { - "description": "in case of failure, details are displayed", - "name": "details", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "the hosts updated", - "name": "hostsupdated", + "description": "the hosts skipped", + "name": "hostsskipped", "response": [ { - "description": "the name of the updated host", - "name": "hostname", - "type": "string" - }, - { - "description": "end date of the update on the host", - "name": "enddate", + "description": "the reason to skip the host", + "name": "reason", "type": "string" }, { - "description": "the ID of the updated host", + "description": "the ID of the skipped host", "name": "hostid", "type": "string" }, { - "description": "start date of the update on the host", - "name": "startdate", - "type": "string" - }, - { - "description": "output of the maintenance script on the host", - "name": "output", + "description": "the name of the skipped host", + "name": "hostname", "type": "string" } ], "type": "list" }, - {}, { - "description": "the hosts skipped", - "name": "hostsskipped", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "indicates if the rolling maintenance operation was successful", + "name": "success", + "type": "boolean" + }, + { + "description": "the hosts updated", + "name": "hostsupdated", "response": [ { - "description": "the reason to skip the host", - "name": "reason", + "description": "start date of the update on the host", + "name": "startdate", "type": "string" }, { - "description": "the name of the skipped host", + "description": "the name of the updated host", "name": "hostname", "type": "string" }, { - "description": "the ID of the skipped host", + "description": "output of the maintenance script on the host", + "name": "output", + "type": "string" + }, + { + "description": "end date of the update on the host", + "name": "enddate", + "type": "string" + }, + { + "description": "the ID of the updated host", "name": "hostid", "type": "string" } @@ -3218,19 +3238,9 @@ }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" } ] }, @@ -3262,64 +3272,64 @@ "type": "string" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" } ], "related": "createTungstenFabricApplicationPolicySet", "response": [ { - "description": "list Tungsten-Fabric tag", - "name": "tag", - "type": "list" + "description": "Tungsten-Fabric policy name", + "name": "name", + "type": "string" }, { "description": "Tungsten-Fabric provider zone id", "name": "zoneid", "type": "long" }, + {}, { - "description": "Tungsten-Fabric policy name", - "name": "name", - "type": "string" + "description": "list Tungsten-Fabric firewall policy", + "name": "firewallpolicy", + "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": "list Tungsten-Fabric firewall policy", - "name": "firewallpolicy", + "description": "list Tungsten-Fabric tag", + "name": "tag", "type": "list" }, - {}, { "description": "Tungsten-Fabric application policy uuid", "name": "uuid", "type": "string" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "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" - }, - {} + } ] }, { @@ -3328,12 +3338,20 @@ "name": "updateNetworkACLList", "params": [ { - "description": "Description of the network ACL list", + "description": "Name of the network ACL list", "length": 255, - "name": "description", + "name": "name", "required": false, "type": "string" }, + { + "description": "the ID of the network ACL", + "length": 255, + "name": "id", + "related": "createNetworkACLList,listNetworkACLLists", + "required": true, + "type": "uuid" + }, { "description": "an optional field, whether to the display the list to the end user or not", "length": 255, @@ -3343,9 +3361,9 @@ "type": "boolean" }, { - "description": "Name of the network ACL list", + "description": "Description of the network ACL list", "length": 255, - "name": "name", + "name": "description", "required": false, "type": "string" }, @@ -3356,14 +3374,6 @@ "required": false, "since": "4.4", "type": "string" - }, - { - "description": "the ID of the network ACL", - "length": 255, - "name": "id", - "related": "createNetworkACLList,listNetworkACLLists", - "required": true, - "type": "uuid" } ], "response": [ @@ -3372,6 +3382,12 @@ "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", @@ -3382,12 +3398,6 @@ "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.4" @@ -3398,60 +3408,146 @@ "name": "restoreVirtualMachine", "params": [ { - "description": "used to specify the custom parameters", + "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": "details", + "name": "templateid", + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", "required": false, - "since": "4.19.1", - "type": "map" + "type": "uuid" }, { - "description": "Optional field to expunge old root volume after restore.", + "description": "Override root volume's diskoffering.", "length": 255, - "name": "expunge", + "name": "diskofferingid", + "related": "createDiskOffering,updateDiskOffering,listDiskOfferings", "required": false, "since": "4.19.1", - "type": "boolean" + "type": "uuid" }, { "description": "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,createVMFromBackup,createVMFromBackup,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", "required": true, "type": "uuid" }, { - "description": "Override root volume's size (in GB). Analogous to details[0].rootdisksize, which takes precedence over this parameter if both are provided", + "description": "used to specify the custom parameters", "length": 255, - "name": "rootdisksize", + "name": "details", "required": false, "since": "4.19.1", - "type": "long" + "type": "map" }, { - "description": "Override root volume's diskoffering.", + "description": "Override root volume's size (in GB). Analogous to details[0].rootdisksize, which takes precedence over this parameter if both are provided", "length": 255, - "name": "diskofferingid", - "related": "createDiskOffering,updateDiskOffering,listDiskOfferings", + "name": "rootdisksize", "required": false, "since": "4.19.1", - "type": "uuid" + "type": "long" }, { - "description": "an optional template Id to restore vm from the new template. This can be an ISO id in case of restore vm deployed using ISO", + "description": "Optional field to expunge old root volume after restore.", "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", + "name": "expunge", "required": false, - "type": "uuid" + "since": "4.19.1", + "type": "boolean" } ], - "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,createVMFromBackup,createVMFromBackup,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", "response": [ { - "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": "User VM type", + "name": "vmtype", + "type": "string" + }, + { + "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 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": "CPU arch of the VM", + "name": "arch", + "type": "string" + }, + { + "description": "the pool type of the virtual machine", + "name": "pooltype", + "type": "string" + }, + { + "description": "the maximum number of display heads", + "name": "maxheads", + "type": "long" + }, + { + "description": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" + }, + { + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" + }, + { + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, + { + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" + }, + { + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "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": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, + { + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { @@ -3459,19 +3555,14 @@ "name": "nic", "response": [ { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", "type": "list" }, { - "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 NSX Logical Switch Port (if NSX based), null otherwise", @@ -3479,28 +3570,33 @@ "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "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": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "the IPv6 address of network", + "name": "ip6address", "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": "the ip address of the nic", - "name": "ipaddress", + "description": "the type of the nic", + "name": "type", "type": "string" }, { @@ -3509,55 +3605,60 @@ "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the netmask of the nic", + "name": "netmask", "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 isolation uri of the nic", - "name": "isolationuri", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "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 isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", + "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", @@ -3569,121 +3670,106 @@ "type": "integer" }, { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" } ], "type": "set" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, + { + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, { "description": "the outgoing network traffic on the host in KiB", "name": "networkkbswrite", "type": "long" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" - }, - { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", - "type": "string" - }, - { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" - }, - { - "description": "the maximum Y resolution", - "name": "maxresolutiony", - "type": "long" + "description": "Instance lease duration in days", + "name": "leaseduration", + "type": "integer" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "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 name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { @@ -3692,99 +3778,59 @@ "type": "long" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "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 number of display heads", - "name": "maxheads", - "type": "long" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", "type": "long" }, - { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", - "type": "string" - }, - { - "description": "State of the Service from LB rule", - "name": "servicestate", - "type": "string" - }, + {}, { "description": "the ID of the vgpu profile to which service offering is linked", "name": "vgpuprofileid", "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", + "description": "the maximum Y resolution", + "name": "maxresolutiony", "type": "long" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", "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": "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", + "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 gpu card to which service offering is linked", - "name": "gpucardid", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "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": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, - { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { @@ -3793,170 +3839,8 @@ "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": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", - "type": "string" - }, - { - "description": "the format of the template for the virtual machine", - "name": "templateformat", - "type": "string" - }, - { - "description": "Instance lease duration in days", - "name": "leaseduration", - "type": "integer" - }, - { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", - "type": "string" - }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "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", - "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", - "type": "string" - }, - { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "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", - "response": [ - { - "description": "the ID of the affinity group", - "name": "id", - "type": "string" - }, - { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" - }, - { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", - "type": "list" - }, - { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" - }, - { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the project name of the affinity group", - "name": "project", - "type": "string" - }, - { - "description": "the description of the affinity group", - "name": "description", - "type": "string" - }, - { - "description": "the type of the affinity group", - "name": "type", - "type": "string" - }, - { - "description": "the 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": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the state of the virtual machine", - "name": "state", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { @@ -3965,146 +3849,8 @@ "type": "boolean" }, { - "description": "Instance lease expiry date", - "name": "leaseexpirydate", - "type": "date" - }, - { - "description": "the name of the gpu card to which service offering is linked", - "name": "gpucardname", - "type": "string" - }, - {}, - { - "description": "the video RAM size in MB", - "name": "videoram", - "type": "long" - }, - { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" - }, - { - "description": "the 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", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the 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": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the name of the 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", - "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", - "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", - "type": "string" - }, - { - "description": "the ID of the host for the virtual machine", - "name": "hostid", - "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", + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", "type": "string" }, { @@ -4113,136 +3859,36 @@ "type": "long" }, { - "description": "OS name of the vm", - "name": "osdisplayname", - "type": "string" - }, - { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", - "type": "string" - }, - { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" - }, - { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" - }, - { - "description": "the group name of the virtual machine", - "name": "group", - "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", - "type": "string" - }, - { - "description": "Guest vm Boot Mode", - "name": "bootmode", - "type": "string" - }, - { - "description": "the group ID of the virtual machine", - "name": "groupid", - "type": "string" - }, - { - "description": "the name of the vgpu profile to which service offering is linked", - "name": "vgpuprofilename", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", - "type": "string" - }, - { - "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 project name of the vm", - "name": "project", - "type": "string" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { "description": "list of security groups associated with the virtual machine", "name": "securitygroup", "response": [ { - "description": "the account owning the security group", - "name": "account", - "type": "string" - }, - { - "description": "the list of 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 description of the security group", + "name": "description", "type": "string" }, { - "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 egress rules associated with the security group", "name": "egressrule", "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", + "description": "the type of the ICMP message response", + "name": "icmptype", "type": "integer" }, { @@ -4250,33 +3896,28 @@ "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": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -4285,41 +3926,41 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag value", + "name": "value", "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": "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": "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" } ], "type": "set" }, { - "description": "account owning the security group rule", - "name": "account", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { @@ -4328,23 +3969,28 @@ "type": "integer" }, { - "description": "security group name", - "name": "securitygroupname", + "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", "type": "string" } ], "type": "set" }, - { - "description": "the ID of the security group", - "name": "id", - "type": "string" - }, - { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, { "description": "the list of ingress rules associated with the security group", "name": "ingressrule", @@ -4354,28 +4000,53 @@ "name": "endport", "type": "integer" }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "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" + }, + { + "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": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -4383,19 +4054,14 @@ "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": "resource type", - "name": "resourcetype", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -4403,65 +4069,60 @@ "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": "customer associated with the tag", - "name": "customer", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag value", + "name": "value", + "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 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": "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 number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the name of the security group", + "name": "name", "type": "string" }, { @@ -4469,207 +4130,272 @@ "name": "projectid", "type": "string" }, + { + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" + }, { "description": "the 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 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": "the domain associated with the tag", - "name": "domain", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "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 name where tag belongs to", - "name": "project", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], "type": "set" }, { - "description": "the name of the security group", - "name": "name", + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "the project name of the group", + "name": "project", "type": "string" } ], "type": "set" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", + "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": "publicip", + "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": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ + { + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + }, + { + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name of the affinity group", + "name": "project", + "type": "string" + }, + { + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "the type of the affinity group", + "name": "type", + "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 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 id of userdata used for the VM", - "name": "userdataid", + "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": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "Guest vm Boot Type", + "name": "boottype", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the speed of each vCPU", + "name": "cpuspeed", "type": "integer" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "the group name of the virtual machine", + "name": "group", "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": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", + "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 name of userdata used for the VM", - "name": "userdataname", - "type": "string" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "CPU arch of the VM", - "name": "arch", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, - {} - ], - "since": "3.0.0" - }, - { - "description": " delete a nicira nvp device", - "isasync": true, - "name": "deleteNiciraNvpDevice", - "params": [ { - "description": "Nicira device ID", - "length": 255, - "name": "nvpdeviceid", - "related": "addNiciraNvpDevice,listNiciraNvpDevices", - "required": true, - "type": "uuid" - } - ], - "response": [ + "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 name of the template for the virtual machine", + "name": "templatename", + "type": "string" }, - {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, - {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "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": "OS name of the vm", + "name": "osdisplayname", "type": "string" - } - ] - }, - { - "description": "Notify provision has been done on a host. This api is for baremetal virtual router service, not for end user", - "isasync": true, - "name": "notifyBaremetalProvisionDone", - "params": [ + }, { - "description": "mac of the nic used for provision", - "length": 255, - "name": "mac", - "required": true, - "type": "object" - } - ], - "response": [ - {}, + "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", - "type": "integer" + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { @@ -4677,11 +4403,295 @@ "name": "jobid", "type": "string" }, - {}, { - "description": "true if operation is executed successfully", - "name": "success", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", + "type": "string" + }, + { + "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 maximum X resolution", + "name": "maxresolutionx", + "type": "long" + }, + { + "description": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" + }, + { + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "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": "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": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + } + ], + "type": "set" + }, + { + "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 count of GPUs on the virtual machine", + "name": "gpucount", + "type": "integer" + }, + { + "description": "Base64 string containing the user data", + "name": "userdata", + "type": "string" + }, + { + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" + }, + { + "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": "the total number of network traffic bytes sent", + "name": "sentbytes", + "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": "the ID of the availability zone for the virtual machine", + "name": "zoneid", + "type": "string" + }, + { + "description": "the user's name who deployed the virtual machine", + "name": "username", + "type": "string" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the video RAM size in MB", + "name": "videoram", + "type": "long" + }, + { + "description": "the VM's primary IP address", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" + }, + { + "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 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": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" + }, + { + "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": "the ID of the host for the virtual machine", + "name": "hostid", + "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" + } + ], + "since": "3.0.0" + }, + { + "description": " delete a nicira nvp device", + "isasync": true, + "name": "deleteNiciraNvpDevice", + "params": [ + { + "description": "Nicira device ID", + "length": 255, + "name": "nvpdeviceid", + "related": "addNiciraNvpDevice,listNiciraNvpDevices", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + {}, + {}, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + } + ] + }, + { + "description": "Notify provision has been done on a host. This api is for baremetal virtual router service, not for end user", + "isasync": true, + "name": "notifyBaremetalProvisionDone", + "params": [ + { + "description": "mac of the nic used for provision", + "length": 255, + "name": "mac", + "required": true, + "type": "object" + } + ], + "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" } ] }, @@ -4691,12 +4701,11 @@ "name": "listUcsBlades", "params": [ { - "description": "ucs manager id", + "description": "List by keyword", "length": 255, - "name": "ucsmanagerid", - "related": "listUcsManagers,addUcsManager", - "required": true, - "type": "uuid" + "name": "keyword", + "required": false, + "type": "string" }, { "description": "", @@ -4713,40 +4722,41 @@ "type": "integer" }, { - "description": "List by keyword", + "description": "ucs manager id", "length": 255, - "name": "keyword", - "required": false, - "type": "string" + "name": "ucsmanagerid", + "related": "listUcsManagers,addUcsManager", + "required": true, + "type": "uuid" } ], "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": "ucs manager id", + "name": "ucsmanagerid", + "type": "string" }, - {}, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "ucs blade id", - "name": "id", + "description": "cloudstack host id this blade associates to", + "name": "hostid", "type": "string" }, { - "description": "ucs manager id", - "name": "ucsmanagerid", + "description": "ucs blade dn", + "name": "bladedn", "type": "string" }, { @@ -4755,9 +4765,9 @@ "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 +4786,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 +4798,11 @@ "name": "volumeiScsiName", "type": "string" }, - {}, - {} + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } ] }, { @@ -4816,18 +4826,18 @@ "type": "integer" }, { - "description": "Whether the category is featured or not", + "description": "Name for the OS category", "length": 255, - "name": "isfeatured", + "name": "name", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "Name for the OS category", + "description": "Whether the category is featured or not", "length": 255, - "name": "name", + "name": "isfeatured", "required": false, - "type": "string" + "type": "boolean" } ], "related": "listOsCategories,addOsCategory", @@ -4848,10 +4858,15 @@ "type": "string" }, { - "description": "the ID of the OS category", - "name": "id", + "description": "the name of the OS category", + "name": "name", "type": "string" }, + { + "description": "Date when the OS category was created.", + "name": "created", + "type": "date" + }, {}, { "description": "the current status of the latest async job acting on this object", @@ -4859,13 +4874,8 @@ "type": "integer" }, { - "description": "Date when the OS category was created.", - "name": "created", - "type": "date" - }, - { - "description": "the name of the OS category", - "name": "name", + "description": "the ID of the OS category", + "name": "id", "type": "string" }, {} @@ -4878,11 +4888,11 @@ "name": "updateHost", "params": [ { - "description": "the new uri for the secondary storage: nfs://host/path", + "description": "list of tags to be added to the host", "length": 255, - "name": "url", + "name": "hosttags", "required": false, - "type": "string" + "type": "list" }, { "description": "the id of Os category to update the host with", @@ -4893,11 +4903,18 @@ "type": "uuid" }, { - "description": "list of tags to be added to the host", + "description": "the new uri for the secondary storage: nfs://host/path", "length": 255, - "name": "hosttags", + "name": "url", "required": false, - "type": "list" + "type": "string" + }, + { + "description": "Whether the informed tag is a JS interpretable rule or not.", + "length": 255, + "name": "istagarule", + "required": false, + "type": "boolean" }, { "description": "Details in key/value pairs using format externaldetails[i].keyname=keyvalue. Example: externaldetails[0].endpoint.url=urlvalue", @@ -4908,137 +4925,118 @@ "type": "map" }, { - "description": "Change the name of host", + "description": "Add an annotation to this host", "length": 255, - "name": "name", + "name": "annotation", "required": false, - "since": "4.15", + "since": "4.11", "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": "the ID of the host to update", "length": 255, - "name": "allocationstate", - "required": false, - "type": "string" + "name": "id", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,updateHost", + "required": true, + "type": "uuid" }, { - "description": "Whether the informed tag is a JS interpretable rule or not.", + "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": "istagarule", + "name": "cleanupexternaldetails", "required": false, + "since": "4.22.0", "type": "boolean" }, { - "description": "the ID of the host to update", + "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": "id", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,updateHost,addBaremetalHost", - "required": true, - "type": "uuid" + "name": "allocationstate", + "required": false, + "type": "string" }, { - "description": "Add an annotation to this host", + "description": "Change the name of host", "length": 255, - "name": "annotation", + "name": "name", "required": false, - "since": "4.11", + "since": "4.15", "type": "string" } ], - "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 incoming network traffic on the host", + "name": "networkkbsread", + "type": "long" }, { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", + "description": "the name of the host", + "name": "name", "type": "string" }, { - "description": "the admin that annotated this host", - "name": "username", + "description": "the cluster ID of the host", + "name": "clusterid", "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 total disk size of the host", - "name": "disksizetotal", - "type": "long" + "description": "the last time this host was annotated", + "name": "lastannotated", + "type": "date" }, { "description": "the amount of the host's memory currently allocated in percentage", "name": "memoryallocatedpercentage", "type": "string" }, - {}, - { - "description": "the ID of the host", - "name": "id", - "type": "string" - }, - { - "description": "the host hypervisor", - "name": "hypervisor", - "type": "string" - }, - {}, { - "description": "the state of the host", - "name": "state", - "type": "status" + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", + "type": "long" }, { - "description": "events available for the host", - "name": "events", + "description": "the cluster type of the cluster that host belongs to", + "name": "clustertype", "type": "string" }, { - "description": "the Zone ID of the host", - "name": "zoneid", + "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", "type": "string" }, { - "description": "the date and time the host was last pinged", - "name": "lastpinged", - "type": "date" - }, - { - "description": "the last time this host was annotated", - "name": "lastannotated", - "type": "date" + "description": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", + "type": "boolean" }, { - "description": "the name of the host", - "name": "name", + "description": "the OS category name of the host", + "name": "oscategoryname", "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": "Total GPUs on the Host", - "name": "gputotal", + "description": "the amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", "type": "long" }, + {}, { - "description": "Host details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the host hypervisor", + "name": "hypervisor", + "type": "string" }, { - "description": "the host type", - "name": "type", - "type": "type" + "description": "true if the host supports encryption", + "name": "encryptionsupported", + "type": "boolean" }, { "description": "true if the entity/resource has annotations", @@ -5046,24 +5044,29 @@ "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 for the host", + "name": "storageaccessgroups", + "type": "string" }, { - "description": "the OS category ID of the host", - "name": "oscategoryid", + "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 after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", "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 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 management server ID of the host", @@ -5071,82 +5074,18 @@ "type": "string" }, { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", - "type": "string" - }, - { - "description": "GPU cards present in the host", - "name": "gpugroup", - "response": [ - { - "description": "the list of enabled vGPUs", - "name": "vgpu", - "response": [ - { - "description": "Maximum Y resolution per display", - "name": "maxresolutiony", - "type": "long" - }, - { - "description": "Maximum displays per user", - "name": "maxheads", - "type": "long" - }, - { - "description": "Model Name of vGPU", - "name": "vgputype", - "type": "string" - }, - { - "description": "Maximum X resolution per display", - "name": "maxresolutionx", - "type": "long" - }, - { - "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", - "name": "remainingcapacity", - "type": "long" - }, - { - "description": "Maximum no. of vgpu per gpu card (pgpu)", - "name": "maxvgpuperpgpu", - "type": "long" - }, - { - "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" - } - ], - "type": "list" - }, - { - "description": "GPU cards present in the host", - "name": "gpugroupname", - "type": "string" - } - ], - "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 state of the host", + "name": "state", + "type": "status" }, { - "description": "comma-separated list of storage access groups on the pod", - "name": "podstorageaccessgroups", + "description": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", "type": "string" }, { - "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", + "description": "the OS category ID of the host", + "name": "oscategoryid", "type": "string" }, { @@ -5155,23 +5094,13 @@ "type": "hostharesponse" }, { - "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", - "type": "long" - }, - { - "description": "true if the host has capability to support UEFI boot", - "name": "ueficapability", + "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": "capabilities of the host", - "name": "capabilities", + "description": "The name of extension for this cluster", + "name": "extensionname", "type": "string" }, { @@ -5179,40 +5108,30 @@ "name": "podid", "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", - "type": "string" - }, { "description": "the amount of the host's memory currently used", "name": "memoryused", "type": "long" }, { - "description": "comma-separated list of storage access groups on the cluster", - "name": "clusterstorageaccessgroups", - "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", + "description": "The ID of extension for this cluster", + "name": "extensionid", "type": "string" }, { - "description": "the cluster ID of the host", - "name": "clusterid", + "description": "the amount of the host's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", - "type": "boolean" + "description": "comma-separated list of tags for the host", + "name": "hosttags", + "type": "string" }, { "description": "the Pod name of the host", @@ -5220,18 +5139,23 @@ "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 host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "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": "capabilities of the host", + "name": "capabilities", + "type": "string" + }, + { + "description": "the cluster name of the host", + "name": "clustername", "type": "string" }, { @@ -5240,156 +5164,250 @@ "type": "string" }, { - "description": "CPU Arch of the host", - "name": "arch", + "description": "the admin that annotated this host", + "name": "username", "type": "string" }, { - "description": "the CPU number of the host", - "name": "cpunumber", - "type": "integer" + "description": "the cpu average load on the host", + "name": "cpuloadaverage", + "type": "double" }, { - "description": "the IP address of the host", - "name": "ipaddress", + "description": "the virtual machine id for host type ConsoleProxy and SecondaryStorageVM", + "name": "virtualmachineid", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", + "description": "the management server name of the host", + "name": "managementservername", "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 percentage", + "name": "cpuallocatedpercentage", + "type": "string" }, { - "description": "the hypervisor version", - "name": "hypervisorversion", - "type": "string" + "description": "the date and time the host was created", + "name": "created", + "type": "date" }, { - "description": "The name of extension for this cluster", - "name": "extensionname", - "type": "string" + "description": "Host details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "The ID of extension for this cluster", - "name": "extensionid", - "type": "string" + "description": "the date and time the host was last pinged", + "name": "lastpinged", + "type": "date" }, { - "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": "comma-separated list of storage access groups for the host", - "name": "storageaccessgroups", + "description": "the Zone ID of the host", + "name": "zoneid", "type": "string" }, { - "description": "the cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" + "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", + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" + }, + { + "description": "comma-separated list of storage access groups on the pod", + "name": "podstorageaccessgroups", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated in MHz", - "name": "cpuallocatedvalue", + "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "name": "memorytotal", "type": "long" }, + {}, { - "description": "the host version", - "name": "version", - "type": "string" + "description": "Used GPUs on the Host", + "name": "gpuused", + "type": "long" }, { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", + "description": "the hypervisor version", + "name": "hypervisorversion", "type": "string" }, { - "description": "true if the host is disconnected. False otherwise.", - "name": "disconnected", - "type": "date" + "description": "the number of CPU sockets on the host", + "name": "cpusockets", + "type": "integer" }, { - "description": "the management server name of the host", - "name": "managementservername", + "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": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" }, { - "description": "the number of CPU sockets on the host", - "name": "cpusockets", - "type": "integer" + "description": "the host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" }, { - "description": "Used GPUs on the Host", - "name": "gpuused", + "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", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the Zone name of the host", - "name": "zonename", - "type": "string" + "description": "Total GPUs on the Host", + "name": "gputotal", + "type": "long" }, { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", + "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", + "name": "hahost", "type": "boolean" }, { - "description": "the OS category name of the host", - "name": "oscategoryname", + "description": "the CPU number of the host", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "the ID of the host", + "name": "id", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "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": "Maximum displays per user", + "name": "maxheads", + "type": "long" + }, + { + "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", + "name": "remainingcapacity", + "type": "long" + }, + { + "description": "Video RAM for this vGPU type", + "name": "videoram", + "type": "long" + }, + { + "description": "Maximum no. of vgpu per gpu card (pgpu)", + "name": "maxvgpuperpgpu", + "type": "long" + }, + { + "description": "Model Name of vGPU", + "name": "vgputype", + "type": "string" + }, + { + "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", + "name": "maxcapacity", + "type": "long" + }, + { + "description": "Maximum X resolution per display", + "name": "maxresolutionx", + "type": "long" + }, + { + "description": "Maximum Y resolution per display", + "name": "maxresolutiony", + "type": "long" + } + ], + "type": "list" + } + ], + "type": "list" }, { - "description": "the last annotation set on this host by an admin", - "name": "annotation", + "description": "the host version", + "name": "version", "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 allocated in bytes", + "name": "memoryallocatedbytes", + "type": "long" }, { - "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 out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" + "description": "comma-separated list of explicit host tags for the host", + "name": "explicithosttags", + "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 has capability to support UEFI boot", + "name": "ueficapability", "type": "boolean" }, - {} + { + "description": "the IP address of the host", + "name": "ipaddress", + "type": "string" + }, + { + "description": "comma-separated list of storage access groups on the cluster", + "name": "clusterstorageaccessgroups", + "type": "string" + }, + { + "description": "CPU Arch of the host", + "name": "arch", + "type": "string" + }, + { + "description": "events available for the host", + "name": "events", + "type": "string" + }, + { + "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", + "type": "string" + } ] }, { @@ -5398,18 +5416,12 @@ "name": "createEgressFirewallRule", "params": [ { - "description": "the protocol for the firewall rule. Valid values are TCP/UDP/ICMP.", - "length": 255, - "name": "protocol", - "required": true, - "type": "string" - }, - { - "description": "the cidr list to forward traffic from. Multiple entries must be separated by a single comma character (,).", + "description": "an optional field, whether to the display the rule to the end user or not", "length": 255, - "name": "cidrlist", + "name": "fordisplay", "required": false, - "type": "list" + "since": "4.4", + "type": "boolean" }, { "description": "error code for this icmp message", @@ -5419,47 +5431,46 @@ "type": "integer" }, { - "description": "the ending port of firewall rule", + "description": "the cidr list to forward traffic to. Multiple entries must be separated by a single comma character (,).", "length": 255, - "name": "endport", + "name": "destcidrlist", "required": false, - "type": "integer" + "type": "list" }, { - "description": "an optional field, whether to the display the rule to the end user or not", + "description": "type of firewallrule: system/user", "length": 255, - "name": "fordisplay", + "name": "type", "required": false, - "since": "4.4", - "type": "boolean" + "type": "string" }, { - "description": "type of the icmp message being sent", + "description": "the starting port of firewall rule", "length": 255, - "name": "icmptype", + "name": "startport", "required": false, "type": "integer" }, { - "description": "type of firewallrule: system/user", + "description": "the protocol for the firewall rule. Valid values are TCP/UDP/ICMP.", "length": 255, - "name": "type", - "required": false, + "name": "protocol", + "required": true, "type": "string" }, { - "description": "the starting port of firewall rule", + "description": "the cidr list to forward traffic from. Multiple entries must be separated by a single comma character (,).", "length": 255, - "name": "startport", + "name": "cidrlist", "required": false, - "type": "integer" + "type": "list" }, { - "description": "the cidr list to forward traffic to. Multiple entries must be separated by a single comma character (,).", + "description": "type of the icmp message being sent", "length": 255, - "name": "destcidrlist", + "name": "icmptype", "required": false, - "type": "list" + "type": "integer" }, { "description": "the network id of the port forwarding rule", @@ -5468,57 +5479,106 @@ "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": true, "type": "uuid" + }, + { + "description": "the ending port of firewall rule", + "length": 255, + "name": "endport", + "required": false, + "type": "integer" } ], "related": "createFirewallRule,listEgressFirewallRules,listFirewallRules,updateEgressFirewallRule,updateFirewallRule", "response": [ { - "description": "the network id of the firewall rule", - "name": "networkid", + "description": "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).", + "name": "destcidrlist", "type": "string" }, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the public ip address id for the firewall rule", + "name": "ipaddressid", "type": "string" }, + {}, + {}, { - "description": "the ID of the firewall rule", - "name": "id", + "description": "the traffic type for the firewall rule", + "name": "traffictype", "type": "string" }, { - "description": "the public ip address id for the firewall rule", - "name": "ipaddressid", + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the protocol of the firewall rule", + "name": "protocol", "type": "string" }, { - "description": "the 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", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "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 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": "error code for this icmp message", + "name": "icmpcode", + "type": "integer" + }, + { + "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" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "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 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 account associated with the tag", + "name": "account", "type": "string" }, { @@ -5527,28 +5587,38 @@ "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 domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "tag value", + "name": "value", "type": "string" }, { @@ -5557,65 +5627,13 @@ "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": "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", - "type": "string" - }, - { - "description": "the starting port of firewall rule's port range", - "name": "startport", - "type": "integer" - }, - { - "description": "the protocol of the firewall rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "error code for this icmp message", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the ending port of firewall rule's port range", - "name": "endport", - "type": "integer" - }, - { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - {}, - { - "description": "the traffic type for the firewall rule", - "name": "traffictype", - "type": "string" - }, - {} + } ] }, { @@ -5624,25 +5642,27 @@ "name": "listSecurityGroups", "params": [ { - "description": "", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "pagesize", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", "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,createVMFromBackup,createVMFromBackup,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "lists security groups by name", + "description": "", "length": 255, - "name": "securitygroupname", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { "description": "list objects by project; if projectid=-1 lists All VMs", @@ -5653,26 +5673,18 @@ "type": "uuid" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "List by keyword", "length": 255, - "name": "account", + "name": "keyword", "required": false, "type": "string" }, { - "description": "List resources by tags (key/value pairs)", - "length": 255, - "name": "tags", - "required": false, - "type": "map" - }, - { - "description": "list only resources belonging to the domain specified", + "description": "lists security groups by name", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", + "name": "securitygroupname", "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.", @@ -5682,12 +5694,11 @@ "type": "boolean" }, { - "description": "list the security group by the id provided", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "id", - "related": "createSecurityGroup,listSecurityGroups,updateSecurityGroup", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { "description": "", @@ -5697,107 +5708,37 @@ "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 resources by tags (key/value pairs)", "length": 255, - "name": "listall", + "name": "tags", "required": false, - "type": "boolean" + "type": "map" }, { - "description": "lists security groups by virtual machine id", + "description": "list the security group by the id provided", "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": "id", + "related": "createSecurityGroup,listSecurityGroups,updateSecurityGroup", "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" } ], "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", + "description": "the list of egress rules associated with the security group", + "name": "egressrule", "response": [ { - "description": "the ending IP of the security group rule ", - "name": "endport", + "description": "the code for the ICMP message response", + "name": "icmpcode", "type": "integer" }, { @@ -5805,16 +5746,6 @@ "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 starting IP of the security group rule", "name": "startport", @@ -5826,19 +5757,24 @@ "type": "string" }, { - "description": "account owning the security group rule", - "name": "account", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, + { + "description": "the 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" }, { "description": "the list of resource tags associated with the rule", @@ -5855,8 +5791,8 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -5865,18 +5801,18 @@ "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 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" }, { @@ -5884,6 +5820,11 @@ "name": "customer", "type": "string" }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, { "description": "tag value", "name": "value", @@ -5893,39 +5834,100 @@ "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": "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": "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": "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": "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": "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" + } + ], + "type": "set" }, - {}, { - "description": "the project name of the group", - "name": "project", + "description": "the domain ID of the security group", + "name": "domainid", "type": "string" }, { - "description": "the project id of the group", - "name": "projectid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", + "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", @@ -5933,51 +5935,81 @@ "type": "string" }, { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", + "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 number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "path of the Domain the security group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the 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 CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, { "description": "the code for the ICMP message response", "name": "icmpcode", "type": "integer" }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "tag value", - "name": "value", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -5991,28 +6023,33 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "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": "tag value", + "name": "value", + "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", @@ -6023,16 +6060,6 @@ "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 ending IP of the security group rule ", "name": "endport", @@ -6046,73 +6073,24 @@ ], "type": "set" }, + {}, { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "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 project name of the group", + "name": "project", "type": "string" }, { - "description": "the ID of the security group", - "name": "id", + "description": "the account owning the security group", + "name": "account", "type": "string" } ] }, - { - "description": "Enables a role", - "isasync": false, - "name": "enableRole", - "params": [ - { - "description": "ID of the role", - "length": 255, - "name": "id", - "related": "createRole,importRole,listRoles,updateRole", - "required": true, - "type": "uuid" - } - ], - "response": [ - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - {}, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ], - "since": "4.20.0" - }, { "description": "List OAuth providers registered", "isasync": false, @@ -6125,17 +6103,10 @@ "required": false, "type": "string" }, - { - "description": "Name of the provider", - "length": 255, - "name": "provider", - "required": false, - "type": "string" - }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, @@ -6147,20 +6118,26 @@ "required": false, "type": "uuid" }, + { + "description": "Name of the provider", + "length": 255, + "name": "provider", + "required": false, + "type": "string" + }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" } ], "related": "verifyOAuthCodeAndGetUser,updateOauthProvider", "response": [ - {}, { - "description": "ID of the provider", - "name": "id", + "description": "Description of the provider registered", + "name": "description", "type": "string" }, { @@ -6168,49 +6145,90 @@ "name": "name", "type": "string" }, + {}, { "description": "Secret key registered in the OAuth provider", "name": "secretkey", "type": "string" }, + { + "description": "Redirect URI registered in the OAuth provider", + "name": "redirecturi", + "type": "string" + }, + {}, { "description": "Name of the provider", "name": "provider", "type": "string" }, + { + "description": "ID of the provider", + "name": "id", + "type": "string" + }, { "description": "Client ID registered in the OAuth provider", "name": "clientid", "type": "string" }, + { + "description": "Whether the OAuth provider is enabled or not", + "name": "enabled", + "type": "boolean" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "Redirect URI registered in the OAuth provider", - "name": "redirecturi", - "type": "string" - }, + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ], + "since": "4.19.0" + }, + { + "description": "Enables a role", + "isasync": false, + "name": "enableRole", + "params": [ { - "description": "Whether the OAuth provider is enabled or not", - "name": "enabled", - "type": "boolean" + "description": "ID of the role", + "length": 255, + "name": "id", + "related": "createRole,importRole,listRoles,updateRole", + "required": true, + "type": "uuid" + } + ], + "response": [ + {}, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { "description": "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": "any text associated with the success or failure", + "name": "displaytext", "type": "string" + }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" } ], - "since": "4.19.0" + "since": "4.20.0" }, { "description": "Delete Service Package", @@ -6227,13 +6245,6 @@ } ], "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", @@ -6244,6 +6255,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", @@ -6257,11 +6275,12 @@ "name": "updateSharedFileSystem", "params": [ { - "description": "the name of the shared filesystem.", + "description": "the ID of the shared filesystem", "length": 255, - "name": "name", - "required": false, - "type": "string" + "name": "id", + "related": "createSharedFileSystem,listSharedFileSystems,updateSharedFileSystem,startSharedFileSystem,stopSharedFileSystem,changeSharedFileSystemDiskOffering,changeSharedFileSystemServiceOffering", + "required": true, + "type": "uuid" }, { "description": "the description for the shared filesystem.", @@ -6271,42 +6290,30 @@ "type": "string" }, { - "description": "the ID of the shared filesystem", + "description": "the name of the shared filesystem.", "length": 255, - "name": "id", - "related": "createSharedFileSystem,listSharedFileSystems,updateSharedFileSystem,startSharedFileSystem,stopSharedFileSystem,changeSharedFileSystemDiskOffering,changeSharedFileSystemServiceOffering", - "required": true, - "type": "uuid" + "name": "name", + "required": false, + "type": "string" } ], "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": "Name of the availability zone", + "name": "zonename", "type": "string" }, - {}, { - "description": "disk offering ID for the shared filesystem", - "name": "diskofferingid", + "description": "ID of the storage fs vm", + "name": "virtualmachineid", "type": "string" }, { - "description": "path to mount the shared filesystem", - "name": "path", + "description": "Network name of the shared filesystem", + "name": "networkname", "type": "string" }, - { - "description": "the bytes actually consumed on disk", - "name": "physicalsize", - "type": "long" - }, { "description": "ID of the shared filesystem", "name": "id", @@ -6318,83 +6325,53 @@ "type": "string" }, { - "description": "the filesystem format", - "name": "filesystem", + "description": "name of the storage pool hosting the data volume", + "name": "storage", "type": "string" }, { - "description": "the project name of the shared filesystem", - "name": "project", + "description": "description of the shared filesystem", + "name": "description", "type": "string" }, { - "description": "the shared filesystem provider", - "name": "provider", + "description": "service offering for the shared filesystem", + "name": "serviceofferingname", "type": "string" }, { - "description": "Network ID of the shared filesystem", - "name": "networkid", + "description": "the ID of the domain associated with the shared filesystem", + "name": "domainid", "type": "string" }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, { "description": "the domain associated with the shared filesystem", "name": "domain", "type": "string" }, { - "description": "Name of the availability zone", - "name": "zonename", - "type": "string" - }, - { - "description": "size of the shared filesystem in GiB", - "name": "sizegb", - "type": "string" - }, - { - "description": "ID of the storage fs vm", - "name": "vmstate", - "type": "string" - }, - { - "description": "name of the shared filesystem", - "name": "name", - "type": "string" - }, - { - "description": "the state of the shared filesystem", - "name": "state", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "name of the storage fs data volume", - "name": "volumename", + "description": "path of the domain to which the shared filesystem", + "name": "domainpath", "type": "string" }, { - "description": "the read (IO) of disk on the shared filesystem", - "name": "diskioread", + "description": "the write (IO) of disk on the shared filesystem", + "name": "diskiowrite", "type": "long" }, { - "description": "description of the shared filesystem", - "name": "description", - "type": "string" - }, - { - "description": "name of the storage pool hosting the data volume", - "name": "storage", + "description": "the account associated with the shared filesystem", + "name": "account", "type": "string" }, { - "description": "service offering for the shared filesystem", - "name": "serviceofferingname", + "description": "Network ID of the shared filesystem", + "name": "networkid", "type": "string" }, { @@ -6403,33 +6380,8 @@ "type": "string" }, { - "description": "size of the shared filesystem", - "name": "size", - "type": "long" - }, - { - "description": "ID of the storage fs vm", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "Network name of the shared filesystem", - "name": "networkname", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "disk offering for the shared filesystem has custom size", - "name": "iscustomdiskoffering", - "type": "boolean" - }, - { - "description": "the ID of the domain associated with the shared filesystem", - "name": "domainid", + "description": "size of the shared filesystem in GiB", + "name": "sizegb", "type": "string" }, { @@ -6437,28 +6389,28 @@ "name": "tags", "response": [ { - "description": "resource type", - "name": "resourcetype", + "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 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": "tag value", + "name": "value", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -6467,18 +6419,13 @@ "type": "string" }, { - "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": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -6490,22 +6437,104 @@ "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": "provisioning type used in the shared filesystem", + "name": "provisioningtype", + "type": "string" + }, + { + "description": "the bytes actually consumed on disk", + "name": "physicalsize", + "type": "long" + }, + { + "description": "the disk utilization", + "name": "utilization", + "type": "string" + }, + { + "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 shared filesystem provider", + "name": "provider", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "name of the shared filesystem", + "name": "name", + "type": "string" + }, + { + "description": "service offering ID for the shared filesystem", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "the project name of the shared filesystem", + "name": "project", + "type": "string" + }, + { + "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", + "type": "string" + }, + { + "description": "the project ID of the shared filesystem", + "name": "projectid", + "type": "string" + }, + { + "description": "size of the shared filesystem", + "name": "size", + "type": "long" + }, + { + "description": "disk offering display text for the shared filesystem", + "name": "diskofferingdisplaytext", + "type": "string" + }, { "description": "the list of nics associated with the shared filesystem", "name": "nic", "response": [ { - "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", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { @@ -6514,73 +6543,63 @@ "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 isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the name of the corresponding network", + "name": "networkname", "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 ip address of the nic", + "name": "ipaddress", + "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", - "type": "string" + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "Type of adapter if available", + "name": "adaptertype", "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": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { @@ -6589,28 +6608,38 @@ "type": "integer" }, { - "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", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "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 VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { @@ -6619,28 +6648,23 @@ "type": "list" }, { - "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 isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the gateway of the nic", + "name": "gateway", "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", - "type": "integer" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { @@ -6649,73 +6673,67 @@ "type": "list" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" } ], "type": "list" }, { - "description": "the shared filesystem's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "the bytes allocated", - "name": "virtualsize", - "type": "long" + "description": "the filesystem format", + "name": "filesystem", + "type": "string" }, - {}, { "description": "the shared filesystem's disk write in KiB", "name": "diskkbswrite", "type": "long" }, { - "description": "the project ID of the shared filesystem", - "name": "projectid", - "type": "string" + "description": "the bytes allocated", + "name": "virtualsize", + "type": "long" }, { - "description": "provisioning type used in the shared filesystem", - "name": "provisioningtype", - "type": "string" + "description": "the read (IO) of disk on the shared filesystem", + "name": "diskioread", + "type": "long" }, { - "description": "service offering ID for the shared filesystem", - "name": "serviceofferingid", + "description": "disk offering ID for the shared filesystem", + "name": "diskofferingid", "type": "string" }, { - "description": "the disk utilization", - "name": "utilization", - "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": "name of the storage fs data volume", + "name": "volumename", "type": "string" }, { - "description": "the account associated with the shared filesystem", - "name": "account", + "description": "path to mount the shared filesystem", + "name": "path", "type": "string" }, { - "description": "disk offering for the shared filesystem", - "name": "diskofferingname", + "description": "the state of the shared filesystem", + "name": "state", "type": "string" }, { - "description": "the write (IO) of disk on the shared filesystem", - "name": "diskiowrite", + "description": "the shared filesystem's disk read in KiB", + "name": "diskkbsread", "type": "long" - }, - { - "description": "disk offering display text for the shared filesystem", - "name": "diskofferingdisplaytext", - "type": "string" } ], "since": "4.20.0" @@ -6725,13 +6743,6 @@ "isasync": true, "name": "updateIpv4SubnetForZone", "params": [ - { - "description": "The new CIDR of the IPv4 subnet.", - "length": 255, - "name": "subnet", - "required": true, - "type": "string" - }, { "description": "Id of the guest network IPv4 subnet", "length": 255, @@ -6739,18 +6750,25 @@ "related": "createIpv4SubnetForZone,listIpv4SubnetsForZone,updateIpv4SubnetForZone,dedicateIpv4SubnetForZone,releaseIpv4SubnetForZone", "required": true, "type": "uuid" + }, + { + "description": "The new CIDR of the IPv4 subnet.", + "length": 255, + "name": "subnet", + "required": true, + "type": "string" } ], "related": "createIpv4SubnetForZone,listIpv4SubnetsForZone,dedicateIpv4SubnetForZone,releaseIpv4SubnetForZone", "response": [ { - "description": "name of zone to which the IPv4 subnet belongs to.", - "name": "zonename", + "description": "the domain name of the IPv4 subnet", + "name": "domain", "type": "string" }, { - "description": "guest IPv4 subnet", - "name": "subnet", + "description": "id of zone to which the IPv4 subnet belongs to.", + "name": "zoneid", "type": "string" }, { @@ -6759,8 +6777,18 @@ "type": "string" }, { - "description": "the project id of the IPv4 subnet", - "name": "projectid", + "description": "the account of the IPv4 subnet", + "name": "account", + "type": "string" + }, + { + "description": "the domain ID of the IPv4 subnet", + "name": "domainid", + "type": "string" + }, + { + "description": "guest IPv4 subnet", + "name": "subnet", "type": "string" }, {}, @@ -6770,18 +6798,18 @@ "type": "string" }, { - "description": "the domain ID of the IPv4 subnet", - "name": "domainid", + "description": "id of the guest IPv4 subnet", + "name": "id", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the project id of the IPv4 subnet", + "name": "projectid", + "type": "string" }, { - "description": "the account of the IPv4 subnet", - "name": "account", + "description": "name of zone to which the IPv4 subnet belongs to.", + "name": "zonename", "type": "string" }, { @@ -6789,21 +6817,11 @@ "name": "created", "type": "date" }, - { - "description": "the domain name of the IPv4 subnet", - "name": "domain", - "type": "string" - }, {}, { - "description": "id of zone to which the IPv4 subnet belongs to.", - "name": "zoneid", - "type": "string" - }, - { - "description": "id of the guest IPv4 subnet", - "name": "id", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ], "since": "4.20.0" @@ -6825,14 +6843,14 @@ "related": "listSystemVms,migrateSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm,scaleSystemVm", "response": [ { - "description": "the last disconnected date of host", - "name": "disconnected", - "type": "date" + "description": "the Zone ID for the system VM", + "name": "zoneid", + "type": "string" }, { - "description": "public vlan range", - "name": "publicvlan", - "type": "list" + "description": "the state of the system VM", + "name": "state", + "type": "string" }, { "description": "CPU arch of the system VM", @@ -6840,195 +6858,195 @@ "type": "string" }, { - "description": "guest vlan range", - "name": "guestvlan", - "type": "string" - }, - { - "description": "the link local netmask for the system vm", - "name": "linklocalnetmask", + "description": "the systemvm agent version", + "name": "version", "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" - }, - { - "description": "the Zone name for the system VM", - "name": "zonename", - "type": "string" + "description": "public vlan range", + "name": "publicvlan", + "type": "list" }, { - "description": "the private netmask for the system VM", - "name": "privatenetmask", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "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 link local MAC address for the system vm", + "name": "linklocalmacaddress", "type": "string" }, { - "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 netmask for the system VM", - "name": "publicnetmask", + "description": "the ID of the system VM", + "name": "id", "type": "string" }, { - "description": "the hostname for the system VM", - "name": "hostname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the link local MAC address for the system vm", - "name": "linklocalmacaddress", + "description": "the Pod ID for the system VM", + "name": "podid", "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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the public netmask for the system VM", + "name": "publicnetmask", "type": "string" }, { - "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": "the public MAC address for the system VM", - "name": "publicmacaddress", + "description": "the network domain for the system VM", + "name": "networkdomain", "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 network domain for the system VM", - "name": "networkdomain", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the host ID for the system VM", - "name": "hostid", + "description": "the Zone name for the system VM", + "name": "zonename", "type": "string" }, { - "description": "the number of active console sessions for the console proxy system vm", - "name": "activeviewersessions", - "type": "integer" + "description": "the public IP address for the system VM", + "name": "publicip", + "type": "string" }, { - "description": "the ID of the system VM", - "name": "id", + "description": "the template name for the system VM", + "name": "templatename", "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 Zone ID for the system VM", - "name": "zoneid", + "description": "the name of the service offering of the system virtual machine.", + "name": "serviceofferingname", "type": "string" }, + {}, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the link local IP address for the system vm", + "name": "linklocalip", "type": "string" }, { - "description": "the agent state of the system VM", - "name": "agentstate", + "description": "the host ID for the system VM", + "name": "hostid", "type": "string" }, { - "description": "the system VM type", - "name": "systemvmtype", + "description": "the hostname for the system VM", + "name": "hostname", "type": "string" }, { - "description": "the gateway for the system VM", - "name": "gateway", + "description": "the name of the system VM", + "name": "name", "type": "string" }, + {}, { - "description": "the private MAC address for the system VM", - "name": "privatemacaddress", + "description": "the Pod name for the system VM", + "name": "podname", "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 system VM", - "name": "name", + "description": "the link local netmask for the system vm", + "name": "linklocalnetmask", "type": "string" }, { - "description": "the state of the system VM", - "name": "state", + "description": "the date and time the system VM was created", + "name": "created", + "type": "date" + }, + { + "description": "the template ID for the system VM", + "name": "templateid", "type": "string" }, { - "description": "the Pod ID for the system VM", - "name": "podid", + "description": "the number of active console sessions for the console proxy system vm", + "name": "activeviewersessions", + "type": "integer" + }, + { + "description": "guest vlan range", + "name": "guestvlan", "type": "string" }, { - "description": "the Pod name for the system VM", - "name": "podname", + "description": "the second DNS for the system VM", + "name": "dns2", "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 system VM type", + "name": "systemvmtype", "type": "string" }, { - "description": "the systemvm agent version", - "name": "version", + "description": "the public MAC address for the system VM", + "name": "publicmacaddress", "type": "string" }, { - "description": "the public IP address for the system VM", - "name": "publicip", + "description": "the private IP address for the system VM", + "name": "privateip", "type": "string" }, { - "description": "the template ID for the system VM", - "name": "templateid", + "description": "the control state of the host for the system VM", + "name": "hostcontrolstate", "type": "string" } ] @@ -7039,12 +7057,11 @@ "name": "archiveEvents", "params": [ { - "description": "the IDs of the events", + "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, - "name": "ids", - "related": "listEvents", + "name": "startdate", "required": false, - "type": "list" + "type": "date" }, { "description": "archive by event type", @@ -7054,37 +7071,38 @@ "type": "string" }, { - "description": "end date range to archive events (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")", + "description": "the IDs of the events", "length": 255, - "name": "enddate", + "name": "ids", + "related": "listEvents", "required": false, - "type": "date" + "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\")", + "description": "end date range to archive events (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", - "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", @@ -7099,18 +7117,10 @@ "name": "listASNumbers", "params": [ { - "description": "the zone ID", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" - }, - { - "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" }, @@ -7130,10 +7140,10 @@ "type": "integer" }, { - "description": "the network id", + "description": "the vpc id", "length": 255, - "name": "networkid", - "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "vpcid", + "related": "createVPC,listVPCs,updateVPC,createVPC,listVPCs,updateVPC,migrateVPC", "required": false, "type": "uuid" }, @@ -7146,20 +7156,19 @@ "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" }, { - "description": "the vpc id", + "description": "account name", "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,updateVPC,createVPC,listVPCs,updateVPC,migrateVPC", + "name": "account", + "related": "createAccount,disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", "required": false, - "type": "uuid" + "type": "string" }, { "description": "", @@ -7169,11 +7178,20 @@ "type": "integer" }, { - "description": "List by keyword", + "description": "domain id", "length": 255, - "name": "keyword", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", "required": false, - "type": "string" + "type": "uuid" + }, + { + "description": "the zone ID", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "uuid" }, { "description": "to indicate if the AS number is allocated to any network", @@ -7186,34 +7204,23 @@ "related": "", "response": [ { - "description": "Allocation state", - "name": "allocationstate", - "type": "string" - }, - {}, - { - "description": "the zone name of the AS Number range", - "name": "zonename", + "description": "Domain ID", + "name": "domainid", "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": "Account ID", + "name": "accountid", "type": "string" }, { - "description": "the domain name", - "name": "domain", + "description": "Network ID", + "name": "associatednetworkid", "type": "string" }, { @@ -7222,39 +7229,45 @@ "type": "string" }, { - "description": "Zone ID", - "name": "zoneid", + "description": "the zone name of the AS Number range", + "name": "zonename", "type": "string" }, { - "description": "AS Number ID", - "name": "asnrangeid", + "description": "the account name", + "name": "account", "type": "string" }, + {}, { "description": "AS Number Range", "name": "asnrange", "type": "string" }, + { + "description": "the domain name", + "name": "domain", + "type": "string" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "AS Number", - "name": "asnumber", - "type": "long" + "description": "AS Number ID", + "name": "asnrangeid", + "type": "string" }, - {}, { - "description": "Network Name", - "name": "associatednetworkname", - "type": "string" + "description": "Created Date", + "name": "created", + "type": "date" }, + {}, { - "description": "Network ID", - "name": "associatednetworkid", + "description": "VPC ID", + "name": "vpcid", "type": "string" }, { @@ -7262,25 +7275,30 @@ "name": "id", "type": "string" }, - { - "description": "Domain ID", - "name": "domainid", - "type": "string" - }, { "description": "Allocated Date", "name": "allocated", "type": "date" }, { - "description": "Account ID", - "name": "accountid", + "description": "Zone ID", + "name": "zoneid", "type": "string" }, { - "description": "VPC ID", - "name": "vpcid", + "description": "Allocation state", + "name": "allocationstate", + "type": "string" + }, + { + "description": "Network Name", + "name": "associatednetworkname", "type": "string" + }, + { + "description": "AS Number", + "name": "asnumber", + "type": "long" } ], "since": "4.20.0" @@ -7301,8 +7319,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" }, {}, @@ -7313,8 +7331,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" }, { @@ -7331,17 +7349,17 @@ "name": "listUserData", "params": [ { - "description": "Userdata name to look for", + "description": "List by keyword", "length": 255, - "name": "name", + "name": "keyword", "required": false, "type": "string" }, { - "description": "the ID of the Userdata", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "id", - "related": "listUserData,listCniConfiguration", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, "type": "uuid" }, @@ -7354,61 +7372,61 @@ "type": "uuid" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "the ID of the Userdata", "length": 255, - "name": "isrecursive", + "name": "id", + "related": "listUserData,listCniConfiguration", "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" }, { - "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": "", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "page", + "name": "isrecursive", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources 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": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "listall", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "List by keyword", + "description": "Userdata name to look for", "length": 255, - "name": "keyword", + "name": "name", "required": false, "type": "string" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "", "length": 255, - "name": "listall", + "name": "page", "required": false, - "type": "boolean" + "type": "integer" } ], "related": "listCniConfiguration", "response": [ { - "description": "the project name of the User Data", - "name": "project", + "description": "the owner of the User Data", + "name": "account", "type": "string" }, { @@ -7417,66 +7435,66 @@ "type": "string" }, { - "description": "the domain name of the User Data owner", - "name": "domain", + "description": "the domain id of the User Data owner", + "name": "domainid", "type": "string" }, {}, - {}, + { + "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 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 UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - { - "description": "the domain id of the User Data owner", - "name": "domainid", - "type": "string" - }, { "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in the User Data", "name": "params", "type": "string" }, { - "description": "ID of the User Data", - "name": "id", + "description": "the project id of the User Data", + "name": "projectid", "type": "string" }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, + {}, { "description": "Name of the User Data", "name": "name", "type": "string" }, { - "description": "the owner of the User Data", - "name": "account", + "description": "the owner id of the User Data", + "name": "accountid", "type": "string" }, { - "description": "the project id of the User Data", - "name": "projectid", + "description": "the domain name of the User Data owner", + "name": "domain", "type": "string" }, { "description": "base64 encoded User Data content", "name": "userdata", "type": "string" + }, + { + "description": "ID of the User Data", + "name": "id", + "type": "string" } ], "since": "4.18" @@ -7486,6 +7504,14 @@ "isasync": true, "name": "updateLoadBalancer", "params": [ + { + "description": "the ID of the load balancer", + "length": 255, + "name": "id", + "related": "createRoutingFirewallRule,listRoutingFirewallRules,updateRoutingFirewallRule,createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules", + "required": true, + "type": "uuid" + }, { "description": "an optional field, whether to the display the rule to the end user or not", "length": 255, @@ -7501,151 +7527,79 @@ "required": false, "since": "4.4", "type": "string" - }, - { - "description": "the ID of the load balancer", - "length": 255, - "name": "id", - "related": "createRoutingFirewallRule,listRoutingFirewallRules,updateRoutingFirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule", - "required": true, - "type": "uuid" } ], "related": "createLoadBalancer,listLoadBalancers", "response": [ - { - "description": "Load Balancer source ip network id", - "name": "sourceipaddressnetworkid", - "type": "string" - }, - { - "description": "the description of the Load Balancer", - "name": "description", - "type": "string" - }, - {}, - { - "description": "the name of the Load Balancer", - "name": "name", - "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 domain of the Load Balancer", - "name": "domain", - "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 list of instances associated with the Load Balancer", - "name": "loadbalancerinstance", + "description": "the list of rules associated with the Load Balancer", + "name": "loadbalancerrule", "response": [ { - "description": "the name of the instance", - "name": "name", - "type": "string" - }, - { - "description": "the instance ID", - "name": "id", + "description": "the state of the load balancer rule", + "name": "state", "type": "string" }, { - "description": "the state of the instance", - "name": "state", - "type": "string" + "description": "source port of the load balancer rule", + "name": "sourceport", + "type": "integer" }, { - "description": "the ip address of the instance", - "name": "ipaddress", - "type": "string" + "description": "instance port of the load balancer rule", + "name": "instanceport", + "type": "integer" } ], "type": "list" }, { - "description": "the project id of the Load Balancer", - "name": "projectid", + "description": "Load Balancer network id", + "name": "networkid", "type": "string" }, { - "description": "the domain ID of the Load Balancer", - "name": "domainid", + "description": "the domain of the Load Balancer", + "name": "domain", "type": "string" }, { - "description": "the load balancer algorithm (source, roundrobin, leastconn)", - "name": "algorithm", + "description": "the project id of the Load Balancer", + "name": "projectid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the list of rules associated with the Load Balancer", - "name": "loadbalancerrule", + "description": "the list of resource tags associated with the Load Balancer", + "name": "tags", "response": [ { - "description": "instance port of the load balancer rule", - "name": "instanceport", - "type": "integer" + "description": "id of the resource", + "name": "resourceid", + "type": "string" }, { - "description": "the state of the load balancer rule", - "name": "state", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "source port of the load balancer rule", - "name": "sourceport", - "type": "integer" - } - ], - "type": "list" - }, - { - "description": "Load Balancer source ip", - "name": "sourceipaddress", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the list of resource tags associated with the Load Balancer", - "name": "tags", - "response": [ + "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": "customer associated with the tag", - "name": "customer", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -7654,13 +7608,13 @@ "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" }, { @@ -7669,41 +7623,105 @@ "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 project name where tag belongs to", + "name": "project", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the Load Balancer ID", + "name": "id", + "type": "string" + }, + { + "description": "the name of the Load Balancer", + "name": "name", + "type": "string" + }, + { + "description": "path of the domain to which the Load Balancer belongs", + "name": "domainpath", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "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 account of the Load Balancer", + "name": "account", + "type": "string" + }, + { + "description": "the domain ID of the Load Balancer", + "name": "domainid", + "type": "string" + }, + { + "description": "the list of instances associated with the Load Balancer", + "name": "loadbalancerinstance", + "response": [ + { + "description": "the state of the instance", + "name": "state", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the name of the instance", + "name": "name", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the ip address of the instance", + "name": "ipaddress", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the instance ID", + "name": "id", "type": "string" } ], "type": "list" }, + { + "description": "the description of the Load Balancer", + "name": "description", + "type": "string" + }, + { + "description": "Load Balancer source ip", + "name": "sourceipaddress", + "type": "string" + }, { "description": "is rule for display to the regular user", "name": "fordisplay", "type": "boolean" }, + {}, { - "description": "the Load Balancer ID", - "name": "id", + "description": "Load Balancer source ip network id", + "name": "sourceipaddressnetworkid", "type": "string" } ], @@ -7714,6 +7732,13 @@ "isasync": true, "name": "scaleSystemVm", "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": "The ID of the system vm", "length": 255, @@ -7729,60 +7754,68 @@ "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", - "length": 255, - "name": "details", - "required": false, - "type": "map" } ], "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", "type": "string" }, { - "description": "the host ID for the system VM", - "name": "hostid", + "description": "the state of the system VM", + "name": "state", "type": "string" }, { - "description": "the number of active console sessions for the console proxy system vm", - "name": "activeviewersessions", + "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 netmask for the system VM", - "name": "publicnetmask", + "description": "the link local netmask for the system vm", + "name": "linklocalnetmask", "type": "string" }, { - "description": "the link local IP address for the system vm", - "name": "linklocalip", + "description": "public vlan range", + "name": "publicvlan", + "type": "list" + }, + { + "description": "the agent state of the system VM", + "name": "agentstate", "type": "string" }, { - "description": "the template ID for the system VM", - "name": "templateid", + "description": "the gateway for the system VM", + "name": "gateway", "type": "string" }, { - "description": "the agent state of the system VM", - "name": "agentstate", + "description": "the public IP address for the system VM", + "name": "publicip", "type": "string" }, { - "description": "the systemvm agent version", - "name": "version", + "description": "the Zone name for the system VM", + "name": "zonename", + "type": "string" + }, + { + "description": "the host ID for the system VM", + "name": "hostid", + "type": "string" + }, + { + "description": "the link local IP address for the system vm", + "name": "linklocalip", "type": "string" }, { @@ -7791,80 +7824,89 @@ "type": "string" }, { - "description": "the link local MAC address for the system vm", - "name": "linklocalmacaddress", + "description": "the template name for the system VM", + "name": "templatename", "type": "string" }, { - "description": "the name of the system VM", - "name": "name", + "description": "the private netmask for the system VM", + "name": "privatenetmask", "type": "string" }, { - "description": "the state of the system VM", - "name": "state", + "description": "CPU arch of the system VM", + "name": "arch", "type": "string" }, - {}, { "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 Pod ID for the system VM", + "name": "podid", "type": "string" }, { - "description": "the gateway for the system VM", - "name": "gateway", + "description": "the network domain for the system VM", + "name": "networkdomain", "type": "string" }, { - "description": "the Pod ID for the system VM", - "name": "podid", + "description": "the system VM type", + "name": "systemvmtype", "type": "string" }, - {}, { - "description": "the Zone name for the system VM", - "name": "zonename", + "description": "the private IP address for the system VM", + "name": "privateip", "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": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the public netmask for the system VM", + "name": "publicnetmask", + "type": "string" }, { - "description": "the Zone ID for the system VM", - "name": "zoneid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the template name for the system VM", - "name": "templatename", + "description": "the private MAC address for the system VM", + "name": "privatemacaddress", "type": "string" }, { - "description": "the last disconnected date of host", - "name": "disconnected", + "description": "the date and time the system VM was created", + "name": "created", "type": "date" }, { - "description": "CPU arch of the system VM", - "name": "arch", + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "the number of active console sessions for the console proxy system vm", + "name": "activeviewersessions", + "type": "integer" + }, + { + "description": "the Pod name for the system VM", + "name": "podname", "type": "string" }, { - "description": "the system VM type", - "name": "systemvmtype", + "description": "the template ID for the system VM", + "name": "templateid", "type": "string" }, { @@ -7873,53 +7915,33 @@ "type": "string" }, { - "description": "the Pod name for the system VM", - "name": "podname", + "description": "the last disconnected date of host", + "name": "disconnected", + "type": "date" + }, + { + "description": "the Zone ID for the system VM", + "name": "zoneid", "type": "string" }, { - "description": "the public MAC address for the system VM", - "name": "publicmacaddress", + "description": "the systemvm agent version", + "name": "version", "type": "string" }, { - "description": "the private IP address for the system VM", - "name": "privateip", + "description": "the second DNS for the system VM", + "name": "dns2", "type": "string" }, { - "description": "the private netmask for the system VM", - "name": "privatenetmask", + "description": "the public MAC address for the system VM", + "name": "publicmacaddress", "type": "string" }, { - "description": "the date and time the system VM was created", - "name": "created", - "type": "date" - }, - { - "description": "the link local netmask for the system vm", - "name": "linklocalnetmask", - "type": "string" - }, - { - "description": "the network domain for the system VM", - "name": "networkdomain", - "type": "string" - }, - { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" - }, - { - "description": "public vlan range", - "name": "publicvlan", - "type": "list" - }, - { - "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" }, { @@ -7928,23 +7950,19 @@ "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" }, { - "description": "the private MAC address for the system VM", - "name": "privatemacaddress", + "description": "the link local MAC address for the system vm", + "name": "linklocalmacaddress", "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 system virtual machine.", - "name": "serviceofferingid", + "description": "the name of the service offering of the system virtual machine.", + "name": "serviceofferingname", "type": "string" } ] @@ -7955,11 +7973,11 @@ "name": "verifyOAuthCodeAndGetUser", "params": [ { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { "description": "Name of the provider", @@ -7971,7 +7989,7 @@ { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, @@ -7983,33 +8001,35 @@ "type": "string" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" } ], "related": "updateOauthProvider", "response": [ { - "description": "Description of the provider registered", - "name": "description", + "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": "Name of the provider", + "name": "provider", + "type": "string" }, { - "description": "ID of the provider", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Name of the provider", - "name": "provider", + "description": "Description of the provider registered", + "name": "description", "type": "string" }, { @@ -8018,26 +8038,24 @@ "type": "string" }, { - "description": "Name of the provider", - "name": "name", + "description": "Client ID registered in the OAuth provider", + "name": "clientid", "type": "string" }, { - "description": "Client ID registered in the OAuth provider", - "name": "clientid", + "description": "ID of the provider", + "name": "id", "type": "string" }, - {}, - {}, { "description": "Secret key registered in the OAuth provider", "name": "secretkey", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "Whether the OAuth provider is enabled or not", @@ -8060,13 +8078,6 @@ "required": false, "type": "uuid" }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, { "description": "", "length": 255, @@ -8088,52 +8099,59 @@ "related": "listClusterDrsPlan,generateClusterDrsPlan,executeClusterDrsPlan", "required": false, "type": "uuid" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" } ], "related": "generateClusterDrsPlan,executeClusterDrsPlan", "response": [ - { - "description": "Start event Id of the DRS Plan", - "name": "eventid", - "type": "string" - }, - {}, { "description": "List of migrations", "name": "migrations", "type": "list" }, { - "description": "unique ID of the drs plan for cluster", - "name": "id", + "description": "Id of the cluster", + "name": "clusterid", "type": "string" }, { - "description": "Type of DRS Plan (Automated or Manual))", - "name": "type", - "type": "type" + "description": "unique ID of the drs plan for cluster", + "name": "id", + "type": "string" }, { "description": "Status of DRS Plan", "name": "status", "type": "status" }, + {}, + {}, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Start event Id of the DRS Plan", + "name": "eventid", "type": "string" }, - {}, - {}, { - "description": "Id of the cluster", - "name": "clusterid", + "description": "the UUID of the latest async 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": "Type of DRS Plan (Automated or Manual))", + "name": "type", + "type": "type" } ], "since": "4.19.0" @@ -8144,47 +8162,45 @@ "name": "listClusters", "params": [ { - "description": "lists clusters by Zone ID", + "description": "", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "page", "required": false, - "type": "uuid" + "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 allocation state", + "description": "flag to display the capacity of the clusters", "length": 255, - "name": "allocationstate", + "name": "showcapacities", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "lists clusters by the cluster ID", + "description": "CPU arch of the clusters", "length": 255, - "name": "id", - "related": "addCluster,listClusters,updateCluster", + "name": "arch", "required": false, - "type": "uuid" + "since": "4.20.1", + "type": "string" }, { - "description": "", + "description": "lists clusters by cluster type", "length": 255, - "name": "page", + "name": "clustertype", "required": false, - "type": "integer" + "type": "string" }, { - "description": "lists clusters by the cluster name", + "description": "lists clusters by allocation state", "length": 255, - "name": "name", + "name": "allocationstate", "required": false, "type": "string" }, @@ -8196,157 +8212,90 @@ "type": "integer" }, { - "description": "List by keyword", + "description": "the name of the storage access group", "length": 255, - "name": "keyword", + "name": "storageaccessgroup", "required": false, + "since": "4.21.0", "type": "string" }, { - "description": "lists clusters by hypervisor type", + "description": "List by keyword", "length": 255, - "name": "hypervisor", + "name": "keyword", "required": false, "type": "string" }, { - "description": "lists clusters by cluster type", + "description": "whether this cluster is managed by cloudstack", "length": 255, - "name": "clustertype", + "name": "managedstate", "required": false, "type": "string" }, { - "description": "lists clusters by Pod ID", + "description": "lists clusters by the cluster name", "length": 255, - "name": "podid", - "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", + "name": "name", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "flag to display the capacity of the clusters", + "description": "lists clusters by Zone ID", "length": 255, - "name": "showcapacities", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "the name of the storage access group", + "description": "lists clusters by the cluster ID", "length": 255, - "name": "storageaccessgroup", + "name": "id", + "related": "addCluster,listClusters,updateCluster", "required": false, - "since": "4.21.0", - "type": "string" + "type": "uuid" }, { - "description": "whether this cluster is managed by cloudstack", + "description": "lists clusters by Pod ID", "length": 255, - "name": "managedstate", + "name": "podid", + "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", "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", + "description": "comma-separated list of storage access groups on the zone", + "name": "zonestorageaccessgroups", "type": "string" }, {}, - { - "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 memory overcommit ratio of the cluster", - "name": "memoryovercommitratio", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "Ovm3 VIP to use for pooling and/or clustering", - "name": "ovm3vip", - "type": "string" - }, - { - "description": "The name of extension for this cluster", - "name": "extensionname", - "type": "string" - }, - { - "description": "Meta data associated with the zone (key/value pairs)", - "name": "resourcedetails", - "type": "map" - }, - { - "description": "comma-separated list of storage access groups for the host", - "name": "storageaccessgroups", - "type": "string" - }, + {}, { "description": "comma-separated list of storage access groups on the pod", "name": "podstorageaccessgroups", "type": "string" }, - { - "description": "the cluster name", - "name": "name", - "type": "string" - }, - { - "description": "The ID of extension for this cluster", - "name": "extensionid", - "type": "string" - }, - { - "description": "The cpu overcommit ratio of the cluster", - "name": "cpuovercommitratio", - "type": "string" - }, - { - "description": "CPU Arch of the hosts in the cluster", - "name": "arch", - "type": "string" - }, - { - "description": "the Zone name of the cluster", - "name": "zonename", - "type": "string" - }, { "description": "the capacity of the Cluster", "name": "capacity", "response": [ { - "description": "the percentage of capacity currently in use", - "name": "percentused", + "description": "the Cluster ID", + "name": "clusterid", + "type": "string" + }, + { + "description": "the Pod ID", + "name": "podid", + "type": "string" + }, + { + "description": "the Pod name", + "name": "podname", "type": "string" }, { @@ -8354,6 +8303,16 @@ "name": "type", "type": "short" }, + { + "description": "the Cluster name", + "name": "clustername", + "type": "string" + }, + { + "description": "the Zone ID", + "name": "zoneid", + "type": "string" + }, { "description": "The tag for the capacity type", "name": "tag", @@ -8365,13 +8324,13 @@ "type": "long" }, { - "description": "the total capacity available", - "name": "capacitytotal", + "description": "the capacity currently in use", + "name": "capacityused", "type": "long" }, { - "description": "the Pod name", - "name": "podname", + "description": "the capacity name", + "name": "name", "type": "string" }, { @@ -8380,46 +8339,37 @@ "type": "string" }, { - "description": "the Cluster ID", - "name": "clusterid", - "type": "string" - }, - { - "description": "the capacity name", - "name": "name", - "type": "string" - }, - { - "description": "the Cluster name", - "name": "clustername", + "description": "the percentage of capacity currently in use", + "name": "percentused", "type": "string" }, { - "description": "the capacity currently in use", - "name": "capacityused", + "description": "the total capacity available", + "name": "capacitytotal", "type": "long" - }, - { - "description": "the Pod ID", - "name": "podid", - "type": "string" - }, - { - "description": "the Zone ID", - "name": "zoneid", - "type": "string" } ], "type": "list" }, + {}, { - "description": "the Zone ID of the cluster", - "name": "zoneid", + "description": "Meta data associated with the zone (key/value pairs)", + "name": "resourcedetails", + "type": "map" + }, + { + "description": "the type of the cluster", + "name": "clustertype", "type": "string" }, { - "description": "the hypervisor type of the cluster", - "name": "hypervisortype", + "description": "The ID of extension for this cluster", + "name": "extensionid", + "type": "string" + }, + { + "description": "Ovm3 VIP to use for pooling and/or clustering", + "name": "ovm3vip", "type": "string" }, { @@ -8428,16 +8378,84 @@ "type": "string" }, { - "description": "comma-separated list of storage access groups on the zone", - "name": "zonestorageaccessgroups", + "description": "the current status of the latest 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 cluster ID", + "name": "id", "type": "string" }, - {}, - {}, { "description": "the Pod ID of the cluster", "name": "podid", "type": "string" + }, + { + "description": "The memory overcommit ratio of the cluster", + "name": "memoryovercommitratio", + "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": "the Zone ID of the cluster", + "name": "zoneid", + "type": "string" + }, + { + "description": "comma-separated list of storage access groups for the host", + "name": "storageaccessgroups", + "type": "string" + }, + { + "description": "The cpu overcommit ratio of the cluster", + "name": "cpuovercommitratio", + "type": "string" + }, + { + "description": "the hypervisor type of the cluster", + "name": "hypervisortype", + "type": "string" + }, + { + "description": "CPU Arch of the hosts in the cluster", + "name": "arch", + "type": "string" + }, + { + "description": "The name of extension for this cluster", + "name": "extensionname", + "type": "string" + }, + { + "description": "the cluster name", + "name": "name", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the Pod name of the cluster", + "name": "podname", + "type": "string" } ] }, @@ -8447,10 +8465,10 @@ "name": "listProjectInvitations", "params": [ { - "description": "list invitations by id", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "id", - "related": "listProjectInvitations", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", "required": false, "type": "uuid" }, @@ -8462,20 +8480,13 @@ "type": "string" }, { - "description": "list by project id", + "description": "list invitation by user ID", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "userid", + "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", "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": "", "length": 255, @@ -8491,18 +8502,19 @@ "type": "boolean" }, { - "description": "if true, list only active invitations - having Pending state and ones that are not timed out yet", + "description": "list invitations by id", "length": 255, - "name": "activeonly", + "name": "id", + "related": "listProjectInvitations", "required": false, - "type": "boolean" + "type": "uuid" }, { - "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.", @@ -8512,44 +8524,56 @@ "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 invitation by user ID", + "description": "list by project id", "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": "", + "description": "list invitations by state", "length": 255, - "name": "pagesize", + "name": "state", "required": false, - "type": "integer" + "type": "string" + }, + { + "description": "if true, list only active invitations - having Pending state and ones that are not timed out yet", + "length": 255, + "name": "activeonly", + "required": false, + "type": "boolean" } ], "related": "", "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the User ID", "name": "userid", "type": "string" }, + {}, { - "description": "the domain id the project belongs to", - "name": "domainid", + "description": "the account name of the project's owner", + "name": "account", "type": "string" }, { - "description": "the id of the invitation", - "name": "id", + "description": "the invitation state", + "name": "state", "type": "string" }, { @@ -8558,47 +8582,41 @@ "type": "string" }, { - "description": "the name of the project", - "name": "project", + "description": "the domain name where the project belongs to", + "name": "domain", "type": "string" }, - {}, { "description": "the email the invitation was sent to", "name": "email", "type": "string" }, { - "description": "the account name of the project's owner", - "name": "account", + "description": "the domain id the project belongs to", + "name": "domainid", "type": "string" }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the id of the invitation", + "name": "id", "type": "string" }, { - "description": "the domain name where the project belongs to", - "name": "domain", + "description": "path of the Domain the project belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the invitation state", - "name": "state", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "path of the Domain the project belongs to", - "name": "domainpath", + "description": "the name of the project", + "name": "project", "type": "string" - } + }, + {} ], "since": "3.0.0" }, @@ -8608,62 +8626,76 @@ "name": "listEgressFirewallRules", "params": [ { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "the network ID for the egress firewall services", "length": 255, - "name": "account", + "name": "networkid", + "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "the ID of IP address of the firewall services", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "ipaddressid", + "related": "associateIpAddress,reserveIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", "required": false, "type": "uuid" }, { - "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": "", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "page", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "List by keyword", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "keyword", + "name": "account", "required": false, "type": "string" }, { - "description": "the ID of IP address of the firewall services", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "ipaddressid", - "related": "associateIpAddress,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", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", + "name": "tags", + "required": false, + "type": "map" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "Lists rule with the specified ID.", + "length": 255, + "name": "id", + "related": "createRoutingFirewallRule,listRoutingFirewallRules,updateRoutingFirewallRule,createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules", "required": false, "type": "uuid" }, @@ -8683,26 +8715,12 @@ "type": "integer" }, { - "description": "the network ID for the egress firewall services", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "networkid", - "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "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, - "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" } ], "related": "createFirewallRule,listFirewallRules,updateEgressFirewallRule,updateFirewallRule", @@ -8712,79 +8730,63 @@ "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", - "type": "string" - }, - { - "description": "error code for this icmp message", - "name": "icmpcode", - "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", + "description": "type of the icmp message being sent", + "name": "icmptype", "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": "the ID of the firewall rule", - "name": "id", - "type": "string" + "description": "the starting port of firewall rule's port range", + "name": "startport", + "type": "integer" }, { - "description": "type of the icmp message being sent", - "name": "icmptype", - "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": "the project name where tag belongs to", - "name": "project", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the 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": "resource type", - "name": "resourcetype", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -8793,36 +8795,37 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "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": "id of the resource", + "name": "resourceid", "type": "string" } ], "type": "list" }, + {}, { - "description": "the protocol of the firewall rule", - "name": "protocol", + "description": "the network id of the firewall rule", + "name": "networkid", "type": "string" }, { - "description": "the starting port of firewall rule's port range", - "name": "startport", + "description": "error code for this icmp message", + "name": "icmpcode", "type": "integer" }, { @@ -8830,27 +8833,42 @@ "name": "cidrlist", "type": "string" }, + { + "description": "the protocol of the firewall rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the public ip address id for the firewall rule", + "name": "ipaddressid", + "type": "string" + }, { "description": "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", + "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 public ip address id for the firewall rule", - "name": "ipaddressid", + "description": "the ID of the firewall rule", + "name": "id", "type": "string" }, - {}, { - "description": "the network id of the firewall rule", - "name": "networkid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - } + }, + {} ] }, { @@ -8859,10 +8877,10 @@ "name": "listClustersMetrics", "params": [ { - "description": "lists clusters by Pod ID", + "description": "lists clusters by the cluster ID", "length": 255, - "name": "podid", - "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", + "name": "id", + "related": "addCluster,updateCluster", "required": false, "type": "uuid" }, @@ -8874,39 +8892,46 @@ "type": "string" }, { - "description": "lists clusters by the cluster ID", + "description": "lists clusters by hypervisor type", "length": 255, - "name": "id", - "related": "addCluster,updateCluster", + "name": "hypervisor", + "required": false, + "type": "string" + }, + { + "description": "lists clusters by Pod ID", + "length": 255, + "name": "podid", + "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", "required": false, "type": "uuid" }, { - "description": "List by keyword", + "description": "lists clusters by cluster type", "length": 255, - "name": "keyword", + "name": "clustertype", "required": false, "type": "string" }, { - "description": "whether this cluster is managed by cloudstack", + "description": "the name of the storage access group", "length": 255, - "name": "managedstate", + "name": "storageaccessgroup", "required": false, + "since": "4.21.0", "type": "string" }, { - "description": "lists clusters by Zone ID", + "description": "flag to display the capacity of the clusters", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "showcapacities", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "lists clusters by cluster type", + "description": "lists clusters by the cluster name", "length": 255, - "name": "clustertype", + "name": "name", "required": false, "type": "string" }, @@ -8918,48 +8943,41 @@ "type": "integer" }, { - "description": "CPU arch of the clusters", + "description": "lists clusters by Zone ID", "length": 255, - "name": "arch", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "since": "4.20.1", - "type": "string" + "type": "uuid" }, { - "description": "lists clusters by hypervisor type", + "description": "List by keyword", "length": 255, - "name": "hypervisor", + "name": "keyword", "required": false, "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "flag to display the capacity of the clusters", + "description": "whether this cluster is managed by cloudstack", "length": 255, - "name": "showcapacities", + "name": "managedstate", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "lists clusters by the cluster name", + "description": "CPU arch of the clusters", "length": 255, - "name": "name", + "name": "arch", "required": false, + "since": "4.20.1", "type": "string" }, { - "description": "the name of the storage access group", + "description": "", "length": 255, - "name": "storageaccessgroup", + "name": "pagesize", "required": false, - "since": "4.21.0", - "type": "string" + "type": "integer" } ], "related": "", @@ -8970,53 +8988,75 @@ "type": "string" }, { - "description": "the type of the cluster", - "name": "clustertype", + "description": "the hypervisor type of the cluster", + "name": "hypervisortype", "type": "string" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "cpu usage disable threshold exceeded", + "name": "cpudisablethreshold", + "type": "boolean" }, { - "description": "comma-separated list of storage access groups for the host", - "name": "storageaccessgroups", + "description": "memory usage notification threshold exceeded", + "name": "memorythreshold", + "type": "boolean" + }, + { + "description": "memory usage disable threshold exceeded", + "name": "memorydisablethreshold", + "type": "boolean" + }, + { + "description": "the maximum memory deviation", + "name": "memorymaxdeviation", "type": "string" }, { - "description": "the total cpu allocated in Ghz", - "name": "cpuallocated", + "description": "comma-separated list of storage access groups on the pod", + "name": "podstorageaccessgroups", "type": "string" }, { - "description": "memory usage disable threshold exceeded", - "name": "memorydisablethreshold", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the cluster ID", - "name": "id", + "description": "running / total hosts in the cluster", + "name": "hosts", "type": "string" }, { - "description": "The ID of extension for this cluster", - "name": "extensionid", + "description": "the type of the cluster", + "name": "clustertype", "type": "string" }, { - "description": "memory usage notification threshold exceeded", - "name": "memorythreshold", - "type": "boolean" + "description": "the total cpu used in GiB", + "name": "memoryused", + "type": "string" }, { "description": "The cpu overcommit ratio of the cluster", "name": "cpuovercommitratio", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the Pod name of the cluster", + "name": "podname", + "type": "string" + }, + { + "description": "the Pod ID of the cluster", + "name": "podid", + "type": "string" + }, + { + "description": "the Zone ID of the cluster", + "name": "zoneid", "type": "string" }, { @@ -9024,39 +9064,44 @@ "name": "capacity", "response": [ { - "description": "the Cluster name", - "name": "clustername", - "type": "string" + "description": "the capacity currently in allocated", + "name": "capacityallocated", + "type": "long" }, { - "description": "the capacity type", - "name": "type", - "type": "short" + "description": "The tag for the capacity type", + "name": "tag", + "type": "string" }, { - "description": "the percentage of capacity currently in use", - "name": "percentused", + "description": "the Pod name", + "name": "podname", "type": "string" }, { - "description": "the capacity currently in use", - "name": "capacityused", + "description": "the total capacity available", + "name": "capacitytotal", "type": "long" }, { - "description": "the capacity name", - "name": "name", + "description": "the Zone name", + "name": "zonename", "type": "string" }, { - "description": "The tag for the capacity type", - "name": "tag", + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" + }, + { + "description": "the percentage of capacity currently in use", + "name": "percentused", "type": "string" }, { - "description": "the total capacity available", - "name": "capacitytotal", - "type": "long" + "description": "the capacity type", + "name": "type", + "type": "short" }, { "description": "the Cluster ID", @@ -9069,127 +9114,101 @@ "type": "string" }, { - "description": "the Zone name", - "name": "zonename", + "description": "the capacity name", + "name": "name", "type": "string" }, { - "description": "the capacity currently in allocated", - "name": "capacityallocated", - "type": "long" + "description": "the Cluster name", + "name": "clustername", + "type": "string" }, { "description": "the Pod ID", "name": "podid", "type": "string" - }, - { - "description": "the Pod name", - "name": "podname", - "type": "string" } ], "type": "list" }, { - "description": "memory allocated notification threshold exceeded", - "name": "memoryallocatedthreshold", - "type": "boolean" + "description": "comma-separated list of storage access groups for the host", + "name": "storageaccessgroups", + "type": "string" }, { - "description": "the Zone name of the cluster", - "name": "zonename", + "description": "the total cpu capacity in Ghz", + "name": "cputotal", "type": "string" }, - {}, { - "description": "cpu allocated disable threshold exceeded", - "name": "cpuallocateddisablethreshold", - "type": "boolean" + "description": "CPU Arch of the hosts in the cluster", + "name": "arch", + "type": "string" }, { - "description": "DRS imbalance for the cluster", - "name": "drsimbalance", - "type": "string" + "description": "cpu allocated notification threshold exceeded", + "name": "cpuallocatedthreshold", + "type": "boolean" }, { - "description": "comma-separated list of storage access groups on the pod", - "name": "podstorageaccessgroups", + "description": "state of the cluster", + "name": "state", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the total cpu allocated in GiB", + "name": "memoryallocated", + "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 Zone ID of the cluster", - "name": "zoneid", + "description": "The ID of extension for this cluster", + "name": "extensionid", "type": "string" }, { - "description": "Meta data associated with the zone (key/value pairs)", - "name": "resourcedetails", - "type": "map" + "description": "memory allocated notification threshold exceeded", + "name": "memoryallocatedthreshold", + "type": "boolean" }, { - "description": "cpu allocated notification threshold exceeded", - "name": "cpuallocatedthreshold", + "description": "cpu allocated disable threshold exceeded", + "name": "cpuallocateddisablethreshold", "type": "boolean" }, { - "description": "the maximum memory deviation", - "name": "memorymaxdeviation", + "description": "the maximum cpu deviation", + "name": "cpumaxdeviation", "type": "string" }, { - "description": "the total cpu used in GiB", - "name": "memoryused", - "type": "string" + "description": "Meta data associated with the zone (key/value pairs)", + "name": "resourcedetails", + "type": "map" }, { - "description": "the Pod ID of the cluster", - "name": "podid", - "type": "string" - }, - { - "description": "the total cpu capacity in Ghz", - "name": "cputotal", + "description": "the total cpu used in Ghz", + "name": "cpuused", "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": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "running / total hosts in the cluster", - "name": "hosts", + "description": "whether this cluster is managed by cloudstack", + "name": "managedstate", "type": "string" }, { - "description": "cpu usage disable threshold exceeded", - "name": "cpudisablethreshold", - "type": "boolean" - }, - { - "description": "the allocation state of the cluster", - "name": "allocationstate", + "description": "DRS imbalance for the cluster", + "name": "drsimbalance", "type": "string" }, { @@ -9197,230 +9216,251 @@ "name": "zonestorageaccessgroups", "type": "string" }, - {}, { - "description": "the total cpu capacity in GiB", - "name": "memorytotal", + "description": "Ovm3 VIP to use for pooling and/or clustering", + "name": "ovm3vip", "type": "string" }, { - "description": "the total cpu allocated in GiB", - "name": "memoryallocated", + "description": "The name of extension for this cluster", + "name": "extensionname", "type": "string" }, { - "description": "the hypervisor type of the cluster", - "name": "hypervisortype", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "The name of extension for this cluster", - "name": "extensionname", + "description": "the total cpu allocated in Ghz", + "name": "cpuallocated", "type": "string" }, { - "description": "the total cpu used in Ghz", - "name": "cpuused", + "description": "The memory overcommit ratio of the cluster", + "name": "memoryovercommitratio", "type": "string" }, {}, { - "description": "Ovm3 VIP to use for pooling and/or clustering", - "name": "ovm3vip", + "description": "the total cpu capacity in GiB", + "name": "memorytotal", "type": "string" }, { - "description": "the Pod name of the cluster", - "name": "podname", - "type": "string" + "description": "memory allocated disable threshold exceeded", + "name": "memoryallocateddisablethreshold", + "type": "boolean" }, { - "description": "state of the cluster", - "name": "state", + "description": "the cluster ID", + "name": "id", "type": "string" }, { - "description": "whether this cluster is managed by cloudstack", - "name": "managedstate", - "type": "string" + "description": "cpu usage notification threshold exceeded", + "name": "cputhreshold", + "type": "boolean" }, { - "description": "the maximum cpu deviation", - "name": "cpumaxdeviation", + "description": "the Zone name of the cluster", + "name": "zonename", "type": "string" } ], "since": "4.9.3" }, { - "description": "Creates a user-defined VM backup schedule", + "description": "Lists objects at specified path on a storage pool.", "isasync": false, - "name": "createBackupSchedule", + "name": "listStoragePoolObjects", "params": [ { - "description": "Specifies a timezone for this command. For more information on the timezone parameter, see TimeZone Format.", + "description": "List by keyword", "length": 255, - "name": "timezone", - "required": true, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "custom backup schedule, the format is:for HOURLY MM*, for DAILY MM:HH*, for WEEKLY MM:HH:DD (1-7)*, for MONTHLY MM:HH:DD (1-28)", + "description": "id of the storage pool", "length": 255, - "name": "schedule", + "name": "id", + "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", "required": true, - "type": "string" + "type": "uuid" }, { - "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.", + "description": "path to list on storage pool", "length": 255, - "name": "quiescevm", + "name": "path", "required": false, - "since": "4.21.0", - "type": "boolean" - }, - { - "description": "valid values are HOURLY, DAILY, WEEKLY, and MONTHLY", - "length": 255, - "name": "intervaltype", - "required": true, "type": "string" }, { - "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.", + "description": "", "length": 255, - "name": "maxbackups", + "name": "page", "required": false, - "since": "4.21.0", "type": "integer" }, { - "description": "ID of the VM for which schedule is to be defined", + "description": "", "length": 255, - "name": "virtualmachineid", - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", - "required": true, - "type": "uuid" + "name": "pagesize", + "required": false, + "type": "integer" } ], - "related": "updateBackupSchedule,listBackups", + "related": "listImageStoreObjects", "response": [ { - "description": "backup date", - "name": "created", - "type": "date" + "description": "Volume ID associated with the data store object.", + "name": "volumeid", + "type": "string" }, { - "description": "backup size in bytes", - "name": "size", - "type": "long" + "description": "Last modified date of the file/directory.", + "name": "lastupdated", + "type": "date" }, { - "description": "name of the backup", - "name": "name", + "description": "Snapshot Name associated with the data store object.", + "name": "snapshotname", "type": "string" }, { - "description": "domain id", - "name": "domainid", + "description": "Template Name associated with the data store object.", + "name": "templatename", "type": "string" }, { - "description": "The backup offering corresponding to this backup was removed from the VM", - "name": "vmbackupofferingremoved", - "type": "boolean" + "description": "Snapshot ID associated with the data store object.", + "name": "snapshotid", + "type": "string" }, { - "description": "backup offering name", - "name": "backupofferingname", - "type": "string" + "description": "Size is in Bytes.", + "name": "size", + "type": "long" }, { - "description": "account name", - "name": "account", - "type": "string" + "description": "Is it a directory.", + "name": "isdirectory", + "type": "boolean" }, { - "description": "backup offering id", - "name": "backupofferingid", + "description": "Format of template associated with the data store object.", + "name": "format", "type": "string" }, { - "description": "backup protected (virtual) size in bytes", - "name": "virtualsize", - "type": "long" + "description": "Volume Name associated with the data store object.", + "name": "volumename", + "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "zone id", - "name": "zoneid", + "description": "Template ID associated with the data store object.", + "name": "templateid", "type": "string" }, { - "description": "zone name", - "name": "zone", + "description": "Name of the data store object.", + "name": "name", "type": "string" }, - {}, { - "description": "backed up volumes", - "name": "volumes", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {} + ], + "since": "4.19.0" + }, + { + "description": "Creates a user-defined VM backup schedule", + "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": "Interval type of the backup", + "description": "valid values are HOURLY, DAILY, WEEKLY, and MONTHLY", + "length": 255, "name": "intervaltype", + "required": true, "type": "string" }, { - "description": "backup type", - "name": "type", - "type": "string" + "description": "Quiesce the instance before checkpointing the disks for backup. Applicable only to NAS backup provider. The filesystem is frozen before the backup starts and thawed immediately after. Requires the instance to have the QEMU Guest Agent installed and running.", + "length": 255, + "name": "quiescevm", + "required": false, + "since": "4.21.0", + "type": "boolean" }, { - "description": "name of the VM", - "name": "virtualmachinename", + "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": "ID of the VM", + "description": "ID of the VM for which schedule is to be defined", + "length": 255, "name": "virtualmachineid", - "type": "string" + "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,createVMFromBackup,createVMFromBackup,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", + "required": true, + "type": "uuid" }, { - "description": "backup status", - "name": "status", - "type": "status" - }, + "description": "The maximum number of backups to keep for a VM. If \"0\", no retention policy will be applied and, thus, no backups from the schedule will be automatically deleted. This parameter is only supported for the Dummy, NAS and EMC Networker backup provider.", + "length": 255, + "name": "maxbackups", + "required": false, + "since": "4.21.0", + "type": "integer" + } + ], + "related": "updateBackupSchedule,listBackups", + "response": [ { - "description": "ID of the VM backup", - "name": "id", + "description": "zone name", + "name": "zone", "type": "string" }, { - "description": "domain name", - "name": "domain", + "description": "account name", + "name": "account", "type": "string" }, - {}, { - "description": "Lists the vm specific details for the backup", - "name": "vmdetails", - "type": "map" + "description": "zone id", + "name": "zoneid", + "type": "string" }, { - "description": "description for the backup", - "name": "description", + "description": "backed up volumes", + "name": "volumes", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "backup date", + "name": "created", + "type": "date" }, { "description": "external backup id", @@ -9428,126 +9468,109 @@ "type": "string" }, { - "description": "account id", - "name": "accountid", + "description": "backup offering name", + "name": "backupofferingname", "type": "string" - } - ], - "since": "4.14.0" - }, - { - "description": "Lists objects at specified path on a storage pool.", - "isasync": false, - "name": "listStoragePoolObjects", - "params": [ + }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "account id", + "name": "accountid", "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": "id of the storage pool", - "length": 255, - "name": "id", - "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", - "required": true, - "type": "uuid" + "description": "backup protected (virtual) size in bytes", + "name": "virtualsize", + "type": "long" }, { - "description": "path to list on storage pool", - "length": 255, - "name": "path", - "required": false, - "type": "string" + "description": "backup status", + "name": "status", + "type": "status" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - } - ], - "related": "listImageStoreObjects", - "response": [ + "description": "Lists the vm specific details for the backup", + "name": "vmdetails", + "type": "map" + }, { - "description": "Name of the data store object.", - "name": "name", + "description": "backup size in bytes", + "name": "size", + "type": "long" + }, + { + "description": "ID of the VM", + "name": "virtualmachineid", "type": "string" }, { - "description": "Format of template associated with the data store object.", - "name": "format", + "description": "domain id", + "name": "domainid", "type": "string" }, - {}, { - "description": "Template Name associated with the data store object.", - "name": "templatename", + "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": "Indicates whether the VM from which the backup was taken is expunged or not", + "name": "isbackupvmexpunged", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "domain name", + "name": "domain", "type": "string" }, + {}, { - "description": "Volume Name associated with the data store object.", - "name": "volumename", + "description": "backup type", + "name": "type", "type": "string" }, { - "description": "Last modified date of the file/directory.", - "name": "lastupdated", - "type": "date" + "description": "name of the VM", + "name": "virtualmachinename", + "type": "string" }, { - "description": "Volume ID associated with the data store object.", - "name": "volumeid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Size is in Bytes.", - "name": "size", - "type": "long" + "description": "The backup offering corresponding to this backup was removed from the VM", + "name": "vmbackupofferingremoved", + "type": "boolean" }, { - "description": "Template ID associated with the data store object.", - "name": "templateid", + "description": "name of the backup", + "name": "name", "type": "string" }, { - "description": "Snapshot ID associated with the data store object.", - "name": "snapshotid", + "description": "backup offering id", + "name": "backupofferingid", "type": "string" }, + {}, { - "description": "Snapshot Name associated with the data store object.", - "name": "snapshotname", + "description": "Interval type of the backup", + "name": "intervaltype", "type": "string" }, { - "description": "Is it a directory.", - "name": "isdirectory", - "type": "boolean" - }, - {} + "description": "description for the backup", + "name": "description", + "type": "string" + } ], - "since": "4.19.0" + "since": "4.14.0" }, { "description": "Lists secondary staging stores.", @@ -9555,75 +9578,95 @@ "name": "listSecondaryStagingStores", "params": [ { - "description": "the staging store provider", + "description": "List by keyword", "length": 255, - "name": "provider", + "name": "keyword", "required": false, "type": "string" }, { - "description": "the ID of the staging store", + "description": "the name of the staging store", "length": 255, - "name": "id", - "related": "addSecondaryStorage,addSwift,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,createSecondaryStagingStore,listSecondaryStagingStores,updateCloudToUseObjectStore", + "name": "name", "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" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "the Zone ID for the staging store", + "description": "the staging store provider", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "provider", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the staging store protocol", + "description": "", "length": 255, - "name": "protocol", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "the name of the staging store", + "description": "the Zone ID for the staging store", "length": 255, - "name": "name", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "", + "description": "the ID of the staging store", "length": 255, - "name": "page", + "name": "id", + "related": "addSecondaryStorage,addSwift,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,createSecondaryStagingStore,listSecondaryStagingStores,updateCloudToUseObjectStore", "required": false, - "type": "integer" + "type": "uuid" } ], "related": "addSecondaryStorage,addSwift,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,createSecondaryStagingStore,updateCloudToUseObjectStore", "response": [ + { + "description": "the name of the image store", + "name": "name", + "type": "string" + }, + { + "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 protocol of the image store", + "name": "protocol", + "type": "string" + }, { "description": "the Zone ID of the image store", "name": "zoneid", "type": "string" }, { - "description": "the name of the image store", - "name": "name", + "description": "the Zone name of the image store", + "name": "zonename", "type": "string" }, { @@ -9636,55 +9679,35 @@ "name": "jobid", "type": "string" }, + { + "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 scope of the image store", - "name": "scope", - "type": "scopetype" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - { - "description": "the protocol of the image store", - "name": "protocol", - "type": "string" - }, - { - "description": "the ID of the image store", - "name": "id", - "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 total disk size of the host", - "name": "disksizetotal", - "type": "long" - }, - { - "description": "the provider name of the image store", - "name": "providername", - "type": "string" + "description": "the scope of the image store", + "name": "scope", + "type": "scopetype" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", + "description": "the total disk size of the host", + "name": "disksizetotal", "type": "long" } ], @@ -9707,8 +9730,33 @@ "related": "destroyRouter,listRouters,rebootRouter,stopRouter,changeServiceForRouter,stopInternalLoadBalancerVM,startInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", "response": [ { - "description": "the Pod ID for the router", - "name": "podid", + "description": "the guest MAC address for the router", + "name": "guestmacaddress", + "type": "string" + }, + { + "description": "CPU arch of the router", + "name": "arch", + "type": "string" + }, + { + "description": "the link local netmask for the router", + "name": "linklocalnetmask", + "type": "string" + }, + { + "description": "the guest netmask for the router", + "name": "guestnetmask", + "type": "string" + }, + { + "description": "role of the domain router", + "name": "role", + "type": "string" + }, + { + "description": "the second IPv6 DNS for the router", + "name": "ip6dns2", "type": "string" }, { @@ -9717,14 +9765,13 @@ "type": "string" }, { - "description": "the ID of the corresponding guest network", - "name": "guestnetworkid", + "description": "the Zone name for the router", + "name": "zonename", "type": "string" }, - {}, { - "description": "the second DNS for the router", - "name": "dns2", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { @@ -9733,22 +9780,47 @@ "type": "string" }, { - "description": "the guest netmask for the router", - "name": "guestnetmask", + "description": "the id of the router", + "name": "id", "type": "string" }, { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the link local MAC address for the router", + "name": "linklocalmacaddress", + "type": "string" + }, + { + "description": "the public IP address for the router", + "name": "publicip", + "type": "string" + }, + { + "description": "the gateway for the router", + "name": "gateway", + "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 list of nics associated with the router", "name": "nic", "response": [ { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { @@ -9757,39 +9829,39 @@ "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the ip address of the nic", + "name": "ipaddress", "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": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" }, { - "description": "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 ip address of the nic", - "name": "ipaddress", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" }, { "description": "public IP address associated with this nic via Static nat rule", @@ -9797,58 +9869,68 @@ "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": "the ID of the nic", - "name": "id", + "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": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "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 cidr of IPv6 network", - "name": "ip6cidr", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "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", + "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": "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": "the type of the nic", - "name": "type", + "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 name of the corresponding network", + "name": "networkname", "type": "string" }, { @@ -9857,18 +9939,18 @@ "type": "list" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { @@ -9877,178 +9959,181 @@ "type": "integer" }, { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "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", - "type": "string" - }, - { - "description": "the network domain for the router", - "name": "networkdomain", - "type": "string" - }, - { - "description": "the name of VPC the router belongs to", - "name": "vpcname", + "description": "the version of template", + "name": "version", "type": "string" }, { - "description": "the control state of the host for the router", - "name": "hostcontrolstate", + "description": "the public MAC address for the router", + "name": "publicmacaddress", "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 second IPv6 DNS for the router", - "name": "ip6dns2", + "description": "the domain ID associated with the router", + "name": "domainid", "type": "string" }, { - "description": "the version of the code / software in the router", - "name": "softwareversion", + "description": "the link local IP address for the router", + "name": "linklocalip", "type": "string" }, { - "description": "the ID of the corresponding public network", - "name": "publicnetworkid", + "description": "the public netmask for the router", + "name": "publicnetmask", "type": "string" }, { - "description": "path of the Domain the router belongs to", - "name": "domainpath", + "description": "the Zone ID for the router", + "name": "zoneid", "type": "string" }, + {}, { - "description": "the Zone name for the router", - "name": "zonename", + "description": "the network domain for the router", + "name": "networkdomain", "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 link local netmask for the router", - "name": "linklocalnetmask", + "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 state of the router", "name": "state", "type": "state" }, { - "description": "the first DNS for the router", - "name": "dns1", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "role of the domain router", - "name": "role", - "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 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" + }, + { + "description": "the date this VPC was created", + "name": "lastupdated", + "type": "date" + } + ], + "type": "list" }, { - "description": "the id of the router", - "name": "id", + "description": "the name of VPC the router belongs to", + "name": "vpcname", "type": "string" }, { - "description": "the host ID for the router", - "name": "hostid", + "description": "the name of the router", + "name": "name", "type": "string" }, { - "description": "the version of template", - "name": "version", + "description": "the version of scripts", + "name": "scriptsversion", "type": "string" }, { - "description": "the domain associated with the router", - "name": "domain", + "description": "the first DNS for the router", + "name": "dns1", "type": "string" }, + {}, { - "description": "the link local MAC address for the router", - "name": "linklocalmacaddress", + "description": "VPC the router belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the guest IP address for the router", - "name": "guestipaddress", + "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", + "description": "the domain associated with the router", + "name": "domain", "type": "string" }, { - "description": "if this router is an redundant virtual router", - "name": "isredundantrouter", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "CPU arch of the router", - "name": "arch", + "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 the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the account associated with the router", - "name": "account", + "description": "the ID of the corresponding link local network", + "name": "linklocalnetworkid", "type": "string" }, { - "description": "the template ID for the router", - "name": "templateid", - "type": "string" + "description": "true if the router template requires upgrader", + "name": "requiresupgrade", + "type": "boolean" }, { "description": "the first IPv6 DNS for the router", @@ -10056,23 +10141,23 @@ "type": "string" }, { - "description": "the name of the router", - "name": "name", + "description": "the hostname for the router", + "name": "hostname", "type": "string" }, { - "description": "the guest MAC address for the router", - "name": "guestmacaddress", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "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 guest IP address for the router", + "name": "guestipaddress", "type": "string" }, { @@ -10081,19 +10166,19 @@ "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the ID of the corresponding public network", + "name": "publicnetworkid", "type": "string" }, { - "description": "the hostname for the router", - "name": "hostname", + "description": "the Pod ID for the router", + "name": "podid", "type": "string" }, { - "description": "the state of redundant virtual router", - "name": "redundantstate", - "type": "string" + "description": "the date and time the router was created", + "name": "created", + "type": "date" }, { "description": "true if any health checks had failed", @@ -10101,81 +10186,24 @@ "type": "boolean" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "the version of scripts", - "name": "scriptsversion", - "type": "string" - }, - { - "description": "the name of the corresponding guest network", - "name": "guestnetworkname", - "type": "string" - }, - { - "description": "Last executed health check result for the router", - "name": "healthcheckresults", - "response": [ - { - "description": "detailed response generated on running health check", - "name": "details", - "type": "string" - }, - { - "description": "the name of the health check on the router", - "name": "checkname", - "type": "string" - }, - { - "description": "the type of the health check - basic or advanced", - "name": "checktype", - "type": "string" - }, - { - "description": "the date this VPC was created", - "name": "lastupdated", - "type": "date" - }, - { - "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 gateway for the router", - "name": "gateway", + "description": "path of the Domain the router belongs to", + "name": "domainpath", "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 host ID for the router", + "name": "hostid", "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "the state of redundant virtual router", + "name": "redundantstate", "type": "string" - }, - { - "description": "true if the router template requires upgrader", - "name": "requiresupgrade", - "type": "boolean" } ] }, @@ -10185,18 +10213,18 @@ "name": "resetConfiguration", "params": [ { - "description": "the ID of the Storage pool to reset the parameter value for corresponding storage pool", + "description": "the ID of the Image Store to reset the parameter value for corresponding image store", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "name": "imagestoreid", + "related": "addSecondaryStorage,addSwift,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,createSecondaryStagingStore,updateCloudToUseObjectStore", "required": false, "type": "uuid" }, { - "description": "the ID of the Zone to reset the parameter value for corresponding zone", + "description": "the ID of the Storage pool to reset the parameter value for corresponding storage pool", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", "required": false, "type": "uuid" }, @@ -10208,10 +10236,10 @@ "type": "string" }, { - "description": "the ID of the Image Store to reset the parameter value for corresponding image store", + "description": "the ID of the Zone to reset the parameter value for corresponding zone", "length": 255, - "name": "imagestoreid", - "related": "addSecondaryStorage,addSwift,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,createSecondaryStagingStore,updateCloudToUseObjectStore", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "uuid" }, @@ -10243,90 +10271,90 @@ "related": "listConfigurations,updateConfiguration", "response": [ { - "description": "the type of the configuration value", - "name": "type", + "description": "the group of the configuration", + "name": "group", "type": "string" }, + { + "description": "true if the configuration is dynamic", + "name": "isdynamic", + "type": "boolean" + }, { "description": "the description of the configuration", "name": "description", "type": "string" }, { - "description": "the possible options of the configuration value", - "name": "options", + "description": "the value of the configuration", + "name": "value", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the category of the configuration", + "name": "category", "type": "string" }, { - "description": "the name of the parent configuration", - "name": "parent", + "description": "the type of the configuration value", + "name": "type", "type": "string" }, { - "description": "the value of the configuration", - "name": "id", - "type": "long" - }, - { - "description": "the value of the configuration", - "name": "value", + "description": "the name of the configuration", + "name": "name", "type": "string" }, { - "description": "true if the configuration is dynamic", - "name": "isdynamic", - "type": "boolean" + "description": "the component of the configuration", + "name": "component", + "type": "string" }, { - "description": "the group of the configuration", - "name": "group", + "description": "the display text of the configuration", + "name": "displaytext", "type": "string" }, { - "description": "the category of the configuration", - "name": "category", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the component of the configuration", - "name": "component", + "description": "the possible options of the configuration value", + "name": "options", "type": "string" }, {}, - {}, { - "description": "the name of the configuration", - "name": "name", + "description": "scope(zone/cluster/pool/account) of the parameter that needs to be updated", + "name": "scope", "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 subgroup of the configuration", + "name": "subgroup", "type": "string" }, { - "description": "scope(zone/cluster/pool/account) of the parameter that needs to be updated", - "name": "scope", + "description": "the default value of the configuration", + "name": "defaultvalue", "type": "string" }, { - "description": "the display text of the configuration", - "name": "displaytext", + "description": "the name of the parent configuration", + "name": "parent", "type": "string" }, { - "description": "the subgroup of the configuration", - "name": "subgroup", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ], @@ -10338,27 +10366,26 @@ "name": "createAutoScalePolicy", "params": [ { - "description": "the cool down period in which the policy should not be evaluated after the action has been taken", + "description": "the name of the autoscale policy", "length": 255, - "name": "quiettime", + "name": "name", "required": false, - "type": "integer" + "since": "4.18.0", + "type": "string" }, { - "description": "the list of IDs of the conditions that are being evaluated on every interval", + "description": "the duration in which the conditions have to be true before action is taken", "length": 255, - "name": "conditionids", - "related": "createCondition,listConditions", + "name": "duration", "required": true, - "type": "list" + "type": "integer" }, { - "description": "the name of the autoscale policy", + "description": "the cool down period in which the policy should not be evaluated after the action has been taken", "length": 255, - "name": "name", + "name": "quiettime", "required": false, - "since": "4.18.0", - "type": "string" + "type": "integer" }, { "description": "the action to be executed if all the conditions evaluate to true for the specified duration.", @@ -10368,55 +10395,45 @@ "type": "string" }, { - "description": "the duration in which the conditions have to be true before action is taken", + "description": "the list of IDs of the conditions that are being evaluated on every interval", "length": 255, - "name": "duration", + "name": "conditionids", + "related": "createCondition,listConditions", "required": true, - "type": "integer" + "type": "list" } ], "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 cool down period for which the policy should not be evaluated after the action has been taken", - "name": "quiettime", - "type": "integer" - }, - { - "description": "the project id autoscale policy", - "name": "projectid", + "description": "the project name of the autoscale policy", + "name": "project", "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": "the list of IDs of the conditions that are being evaluated on every interval", + "name": "conditions", + "type": "list" }, { - "description": "path of the domain to which the autoscale policy belongs", - "name": "domainpath", + "description": "the account owning the autoscale policy", + "name": "account", "type": "string" }, {}, { - "description": "the project name of the autoscale policy", - "name": "project", + "description": "name of the autoscale policy", + "name": "name", "type": "string" }, { - "description": "the autoscale policy ID", - "name": "id", + "description": "the domain name of the autoscale policy", + "name": "domain", "type": "string" }, { @@ -10425,29 +10442,40 @@ "type": "string" }, { - "description": "name of the autoscale policy", - "name": "name", + "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 action to be executed if all the conditions evaluate to true for the specified duration.", - "name": "action", + "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 autoscale policy ID", + "name": "id", "type": "string" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" + }, + { + "description": "the cool down period for which the policy should not be evaluated after the action has been taken", + "name": "quiettime", + "type": "integer" + }, + { + "description": "the duration for which the conditions have to be true before action is taken", + "name": "duration", + "type": "integer" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -10460,24 +10488,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": "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", @@ -10498,13 +10526,19 @@ "related": "", "response": [ { - "description": "the last time a usage job successfully completed", - "name": "lastsuccessfuljob", - "type": "date" + "description": "the name of the active usage server", + "name": "hostname", + "type": "string" }, { - "description": "the time these statistics were collected", - "name": "collectiontime", + "description": "the state of the usage server", + "name": "state", + "type": "state" + }, + {}, + { + "description": "the last time a usage job successfully completed", + "name": "lastsuccessfuljob", "type": "date" }, { @@ -10512,27 +10546,21 @@ "name": "lastheartbeat", "type": "date" }, - {}, { - "description": "the name of the active usage server", - "name": "hostname", + "description": "the UUID of the latest async 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 time these statistics were collected", + "name": "collectiontime", + "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ], "since": "4.17.0" @@ -10552,28 +10580,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": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, - {} + } ], "since": "4.11" }, @@ -10583,27 +10611,27 @@ "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", "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" } ] }, @@ -10613,39 +10641,41 @@ "name": "updateRoutingFirewallRule", "params": [ { - "description": "an optional field, whether to the display the Routing firewall rule 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, - "type": "boolean" + "since": "4.4", + "type": "string" }, { "description": "the ID of the Routing firewall rule", "length": 255, "name": "id", - "related": "createRoutingFirewallRule,listRoutingFirewallRules,updateRoutingFirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule", + "related": "createRoutingFirewallRule,listRoutingFirewallRules,updateRoutingFirewallRule,createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules", "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": "an optional field, whether to the display the Routing firewall rule to the end user or not", "length": 255, - "name": "customid", + "name": "fordisplay", "required": false, - "since": "4.4", - "type": "string" + "type": "boolean" } ], - "related": "createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule", + "related": "createRoutingFirewallRule,listRoutingFirewallRules,createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules", "response": [ { - "description": "the ending port of port forwarding rule's private port range", - "name": "privateendport", + "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", + "description": "the starting port of port forwarding rule's public port range", + "name": "publicport", "type": "string" }, { @@ -10654,8 +10684,8 @@ "type": "string" }, { - "description": "the ID of the port forwarding rule", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -10663,97 +10693,76 @@ "name": "virtualmachinename", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the starting port of port forwarding rule's private port range", - "name": "privateport", - "type": "string" - }, { "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", "name": "cidrlist", "type": "string" }, - {}, - { - "description": "the id of the guest network the port forwarding rule belongs to", - "name": "networkid", - "type": "string" - }, - { - "description": "the state of the rule", - "name": "state", - "type": "string" - }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the 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": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "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": "the account associated with the tag", - "name": "account", + "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": "tag key name", - "name": "key", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], "type": "list" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the public ip address for the port forwarding rule", + "name": "ipaddress", "type": "string" }, { @@ -10761,15 +10770,19 @@ "name": "fordisplay", "type": "boolean" }, - {}, { - "description": "the vm ip address for the port forwarding rule", - "name": "vmguestip", + "description": "the ending port of port forwarding rule's private port range", + "name": "privateendport", "type": "string" }, { - "description": "the public ip address id for the port forwarding rule", - "name": "ipaddressid", + "description": "the 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" }, { @@ -10777,20 +10790,35 @@ "name": "virtualmachineid", "type": "string" }, + { + "description": "the starting port of port forwarding rule's private port range", + "name": "privateport", + "type": "string" + }, + { + "description": "the id of the guest network the port forwarding rule belongs to", + "name": "networkid", + "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 ending port of port forwarding rule's private port range", - "name": "publicendport", + "description": "the state of the rule", + "name": "state", "type": "string" }, { - "description": "the starting port of port forwarding rule's public port range", - "name": "publicport", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ], "since": "4.20.0" @@ -10822,11 +10850,12 @@ "type": "string" }, { - "description": "the object store provider", + "description": "the ID of the storage pool", "length": 255, - "name": "provider", + "name": "id", + "related": "addObjectStoragePool,listObjectStoragePools,updateObjectStoragePool", "required": false, - "type": "string" + "type": "uuid" }, { "description": "List by keyword", @@ -10836,67 +10865,66 @@ "type": "string" }, { - "description": "the ID of the storage pool", + "description": "the object store provider", "length": 255, - "name": "id", - "related": "addObjectStoragePool,listObjectStoragePools,updateObjectStoragePool", + "name": "provider", "required": false, - "type": "uuid" + "type": "string" } ], "related": "addObjectStoragePool,updateObjectStoragePool", "response": [ + {}, { - "description": "the ID of the object store", - "name": "id", - "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" }, { "description": "the url of the object store", "name": "url", "type": "string" }, + { + "description": "the allocated size of the object store", + "name": "storageallocated", + "type": "long" + }, { "description": "the name of the object store", "name": "name", "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the total size of the object store", - "name": "storagetotal", - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the ID of the object store", + "name": "id", + "type": "string" }, { "description": "the object store currently used size", "name": "storageused", "type": "long" }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - {}, { "description": "the provider name of the object store", "name": "providername", "type": "string" - }, - {}, - { - "description": "the allocated size of the object store", - "name": "storageallocated", - "type": "long" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" } ], "since": "4.19.0" @@ -10906,6 +10934,13 @@ "isasync": false, "name": "createSecondaryStagingStore", "params": [ + { + "description": "the staging store provider name", + "length": 255, + "name": "provider", + "required": false, + "type": "string" + }, { "description": "the details for the staging store", "length": 255, @@ -10913,6 +10948,14 @@ "required": false, "type": "map" }, + { + "description": "the Zone ID for the staging store", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "uuid" + }, { "description": "the URL for the staging store", "length": 2048, @@ -10920,102 +10963,87 @@ "required": true, "type": "string" }, - { - "description": "the staging store provider name", - "length": 255, - "name": "provider", - "required": false, - "type": "string" - }, { "description": "the scope of the staging store: zone only for now", "length": 255, "name": "scope", "required": false, "type": "string" - }, - { - "description": "the Zone ID for the staging store", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" } ], "related": "addSecondaryStorage,addSwift,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", "response": [ - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "defines if store is read-only", + "name": "readonly", + "type": "boolean" }, { - "description": "the Zone ID of the image store", - "name": "zoneid", + "description": "the ID of the image store", + "name": "id", "type": "string" }, { - "description": "the name of the image store", - "name": "name", + "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 Zone name of the image store", "name": "zonename", "type": "string" }, { - "description": "the url of the image store", - "name": "url", + "description": "the provider name of the image store", + "name": "providername", "type": "string" }, { - "description": "the scope of the image store", - "name": "scope", - "type": "scopetype" + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" }, { "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", + "description": "the name of the image store", + "name": "name", "type": "string" }, { - "description": "the ID of the image store", - "name": "id", + "description": "the Zone ID of the image store", + "name": "zoneid", "type": "string" }, { - "description": "the provider name of the image store", - "name": "providername", + "description": "the protocol of the image store", + "name": "protocol", "type": "string" }, { - "description": "defines if store is read-only", - "name": "readonly", - "type": "boolean" + "description": "the scope of the image store", + "name": "scope", + "type": "scopetype" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, + {}, { - "description": "the protocol of the image store", - "name": "protocol", + "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" } ] }, @@ -11034,27 +11062,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": "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" } ] }, @@ -11064,11 +11092,11 @@ "name": "runCustomAction", "params": [ { - "description": "Parameters in key/value pairs using format parameters[i].keyname=keyvalue. Example: parameters[0].endpoint.url=urlvalue", + "description": "Type of the resource", "length": 255, - "name": "parameters", + "name": "resourcetype", "required": false, - "type": "map" + "type": "string" }, { "description": "ID of the custom action", @@ -11086,24 +11114,19 @@ "type": "string" }, { - "description": "Type of the resource", + "description": "Parameters in key/value pairs using format parameters[i].keyname=keyvalue. Example: parameters[0].endpoint.url=urlvalue", "length": 255, - "name": "resourcetype", + "name": "parameters", "required": false, - "type": "string" + "type": "map" } ], "related": "", "response": [ { - "description": "Result of the action execution", - "name": "result", - "type": "map" - }, - { - "description": "Whether custom action succeed or not", - "name": "success", - "type": "boolean" + "description": "Name of the action", + "name": "name", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", @@ -11111,11 +11134,10 @@ "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,10 +11145,16 @@ }, {}, { - "description": "Name of the action", - "name": "name", + "description": "ID of the action", + "name": "id", "type": "string" - } + }, + { + "description": "Whether custom action succeed or not", + "name": "success", + "type": "boolean" + }, + {} ], "since": "4.21.0" }, @@ -11163,38 +11191,18 @@ "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", + "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 ID of the HealthCheck policy", "name": "domainid", "type": "string" }, { - "description": "the account of the HealthCheck policy", - "name": "account", + "description": "the id of the zone the HealthCheck policy belongs to", + "name": "zoneid", "type": "string" }, {}, @@ -11203,53 +11211,73 @@ "name": "healthcheckpolicy", "response": [ { - "description": "Time to wait when receiving a response from the health check", - "name": "responsetime", - "type": "int" - }, - { - "description": "is policy for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the state of the policy", + "name": "state", + "type": "string" }, { - "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 state of the policy", - "name": "state", + "description": "the description of the healthcheck policy", + "name": "description", "type": "string" }, { - "description": "Amount of time between health checks", - "name": "healthcheckinterval", + "description": "Time to wait when receiving a response from the health check", + "name": "responsetime", "type": "int" }, + { + "description": "is policy for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, { "description": "the LB HealthCheck policy ID", "name": "id", "type": "string" }, { - "description": "the description of the healthcheck policy", - "name": "description", + "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", + "description": "Number of consecutive health check failures before declaring an instance unhealthy.", + "name": "unhealthcheckthresshold", "type": "int" }, { - "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" } ], "type": "list" }, + { + "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 LB rule ID", + "name": "lbruleid", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, {} ], "since": "4.4" @@ -11268,31 +11296,35 @@ "type": "uuid" }, { - "description": "the Uuid of Tungsten-Fabric policy rule", + "description": "the Uuid of Tungsten-Fabric policy", "length": 255, - "name": "ruleuuid", + "name": "policyuuid", "required": true, "type": "string" }, { - "description": "the Uuid of Tungsten-Fabric policy", + "description": "the Uuid of Tungsten-Fabric policy rule", "length": 255, - "name": "policyuuid", + "name": "ruleuuid", "required": true, "type": "string" } ], "related": "createTungstenFabricPolicy,listTungstenFabricPolicy,applyTungstenFabricPolicy,removeTungstenFabricPolicy", "response": [ - {}, + { + "description": "list Tungsten-Fabric policy network name", + "name": "network", + "type": "list" + }, { "description": "Tungsten-Fabric provider zone id", "name": "zoneid", "type": "long" }, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "Tungsten-Fabric tag type uuid", + "name": "uuid", "type": "string" }, { @@ -11301,26 +11333,22 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "Tungsten-Fabric tag type uuid", - "name": "uuid", + "description": "Tungsten-Fabric policy name", + "name": "name", "type": "string" }, + {}, + {}, { - "description": "list Tungsten-Fabric policy network name", - "name": "network", - "type": "list" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "Tungsten-Fabric policy name", - "name": "name", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, - {}, {} ] }, @@ -11330,38 +11358,31 @@ "name": "createLoadBalancerRule", "params": [ { - "description": "the description of the load balancer rule", - "length": 4096, - "name": "description", - "required": false, - "type": "string" - }, - { - "description": "an optional field, whether to the display the rule to the end user or not", + "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": "fordisplay", + "name": "cidrlist", "required": false, - "since": "4.4", - "type": "boolean" + "since": "4.18.0.0", + "type": "list" }, { - "description": "public IP address ID from where the network traffic will be load balanced from", + "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": "publicipid", - "related": "associateIpAddress,reserveIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "name": "networkid", + "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "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.", + "description": "an optional field, whether to the display the rule to the end user or not", "length": 255, - "name": "cidrlist", + "name": "fordisplay", "required": false, - "since": "4.18.0.0", - "type": "list" + "since": "4.4", + "type": "boolean" }, { - "description": "The protocol for the LB such as tcp, udp or tcp-proxy.", + "description": "The protocol for the LB such as tcp, udp, tcp-proxy or ssl.", "length": 255, "name": "protocol", "required": false, @@ -11375,19 +11396,18 @@ "type": "boolean" }, { - "description": "the public port from where the network traffic will be load balanced from", + "description": "load balancer algorithm (source, roundrobin, leastconn)", "length": 255, - "name": "publicport", + "name": "algorithm", "required": true, - "type": "integer" + "type": "string" }, { - "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", + "description": "the description of the load balancer rule", + "length": 4096, + "name": "description", "required": false, - "type": "uuid" + "type": "string" }, { "description": "name of the load balancer rule", @@ -11397,34 +11417,27 @@ "type": "string" }, { - "description": "the account associated with the load balancer. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, - { - "description": "The guest network this rule will be created for. Required when public Ip address is not associated with any Guest network yet (VPC case)", + "description": "the domain ID associated with the load balancer", "length": 255, - "name": "networkid", - "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", "required": false, "type": "uuid" }, { - "description": "the domain ID associated with the load balancer", + "description": "zone where the load balancer is going to be created. This parameter is required when LB service provider is ElasticLoadBalancerVm", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "uuid" }, { - "description": "load balancer algorithm (source, roundrobin, leastconn)", + "description": "the public port from where the network traffic will be load balanced from", "length": 255, - "name": "algorithm", + "name": "publicport", "required": true, - "type": "string" + "type": "integer" }, { "description": "the private port of the private IP address/virtual machine where the network traffic will be load balanced to", @@ -11432,34 +11445,28 @@ "name": "privateport", "required": true, "type": "integer" - } - ], - "related": "listLoadBalancerRules,updateLoadBalancerRule", - "response": [ - { - "description": "the id of the zone the rule belongs to", - "name": "zoneid", - "type": "string" - }, - { - "description": "the account of the load balancer rule", - "name": "account", - "type": "string" }, { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "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 project id of the load balancer", - "name": "projectid", + "description": "the account associated with the load balancer. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, "type": "string" - }, - {}, + } + ], + "related": "listLoadBalancerRules,updateLoadBalancerRule", + "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", + "description": "the protocol of the loadbalanacer rule", + "name": "protocol", "type": "string" }, { @@ -11468,93 +11475,89 @@ "type": "string" }, { - "description": "the domain ID of the load balancer rule", - "name": "domainid", - "type": "string" - }, - { - "description": "the name of the zone the load balancer rule belongs to", - "name": "zonename", + "description": "the project id of the load balancer", + "name": "projectid", "type": "string" }, { - "description": "the domain of the load balancer rule", - "name": "domain", + "description": "the public port", + "name": "publicport", "type": "string" }, - {}, { "description": "the state of the rule", "name": "state", "type": "string" }, { - "description": "the description of the load balancer", - "name": "description", + "description": "the name of the load balancer", + "name": "name", "type": "string" }, { - "description": "the load balancer rule ID", - "name": "id", + "description": "the account of the load balancer rule", + "name": "account", "type": "string" }, { - "description": "the public ip address", - "name": "publicip", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the private port", - "name": "privateport", + "description": "the load balancer algorithm (source, roundrobin, leastconn)", + "name": "algorithm", "type": "string" }, { - "description": "the name of the load balancer", - "name": "name", + "description": "path of the domain to which the load balancer rule belongs", + "name": "domainpath", "type": "string" }, { - "description": "the public port", - "name": "publicport", + "description": "the id of the guest network the lb rule belongs to", + "name": "networkid", "type": "string" }, { - "description": "the load balancer algorithm (source, roundrobin, leastconn)", - "name": "algorithm", + "description": "the load balancer rule ID", + "name": "id", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the description of the load balancer", + "name": "description", + "type": "string" }, { - "description": "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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain of the load balancer rule", + "name": "domain", "type": "string" }, + {}, { "description": "the list of resource tags associated with load balancer", "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "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" }, { @@ -11563,18 +11566,13 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { @@ -11583,36 +11581,66 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "resource type", + "name": "resourcetype", "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", "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" } ], "type": "list" }, { - "description": "path of the domain to which the load balancer rule belongs", - "name": "domainpath", + "description": "the private port", + "name": "privateport", "type": "string" }, { - "description": "the protocol of the loadbalanacer rule", - "name": "protocol", + "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 id of the zone the rule belongs to", + "name": "zoneid", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,).", + "name": "cidrlist", + "type": "string" + }, + { + "description": "the name of the zone the load balancer rule belongs to", + "name": "zonename", + "type": "string" + }, + { + "description": "the public ip address", + "name": "publicip", + "type": "string" + }, + { + "description": "the domain ID of the load balancer rule", + "name": "domainid", "type": "string" } ] @@ -11633,15 +11661,22 @@ ], "related": "quotaConfigureEmail", "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": "Whether the template is enabled.", - "name": "enabled", - "type": "boolean" + "description": "The configured account's id.", + "name": "account", + "type": "string" }, { "description": "The template's name.", @@ -11649,21 +11684,14 @@ "type": "string" }, { - "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" - }, - {}, - {}, - { - "description": "The configured account's id.", - "name": "account", - "type": "string" } ], "since": "4.20.0.0" @@ -11685,9 +11713,9 @@ "related": "listVsphereStoragePolicies", "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 Zone", @@ -11695,19 +11723,13 @@ "type": "string" }, { - "description": "the description of the Storage Policy", - "name": "description", - "type": "string" - }, - { - "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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the identifier of the Storage Policy in vSphere DataCenter", + "name": "policyid", "type": "string" }, { @@ -11716,9 +11738,15 @@ "type": "string" }, {}, + {}, { - "description": "the identifier of the Storage Policy in vSphere DataCenter", - "name": "policyid", + "description": "the description of the Storage Policy", + "name": "description", + "type": "string" + }, + { + "description": "the ID of the Storage Policy", + "name": "id", "type": "string" } ] @@ -11732,42 +11760,42 @@ "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": "the current status of the latest 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": "Disables out-of-band management for a zone", - "isasync": true, - "name": "disableOutOfBandManagementForZone", - "params": [ + }, + { + "description": "the UUID of the latest async 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": "Disables out-of-band management for a zone", + "isasync": true, + "name": "disableOutOfBandManagementForZone", + "params": [ { "description": "the ID of the zone", "length": 255, @@ -11780,28 +11808,29 @@ "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "the out-of-band management interface password", - "name": "password", + "description": "the 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": "the operation result", + "name": "status", + "type": "boolean" }, { - "description": "the out-of-band management action (if issued)", - "name": "action", + "description": "the out-of-band management interface address", + "name": "address", "type": "string" }, { - "description": "the out-of-band management interface username", - "name": "username", + "description": "the operation result description", + "name": "description", "type": "string" }, { @@ -11809,41 +11838,40 @@ "name": "port", "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 powerState of the host", "name": "powerstate", "type": "powerstate" }, { - "description": "the out-of-band management interface address", - "name": "address", + "description": "the out-of-band management interface username", + "name": "username", "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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the out-of-band management interface password", + "name": "password", "type": "string" }, { - "description": "the operation result description", - "name": "description", + "description": "the out-of-band management action (if issued)", + "name": "action", "type": "string" } ], @@ -11855,9 +11883,9 @@ "name": "createBackup", "params": [ { - "description": "the name of the backup", + "description": "the description for the backup", "length": 255, - "name": "name", + "name": "description", "required": false, "since": "4.21.0", "type": "string" @@ -11871,9 +11899,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,29 +11910,29 @@ "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,createVMFromBackup,createVMFromBackup,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", "required": true, "type": "uuid" } ], "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 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", @@ -11914,132 +11942,315 @@ "since": "4.14.0" }, { - "description": "Stops a system VM.", - "isasync": true, - "name": "stopSystemVm", + "description": "Lists all IPv6 firewall rules", + "isasync": false, + "name": "listIpv6FirewallRules", "params": [ { - "description": "Force stop the VM (vm is marked as Stopped even when command fails to be send to the backend, otherwise a force poweroff is attempted). To be used if the caller knows the VM is stopped and should be marked as such.", + "description": "", "length": 255, - "name": "forced", + "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": "The ID of the system virtual machine", + "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 by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "Lists ipv6 firewall rule with the specified ID", "length": 255, "name": "id", - "related": "listSystemVms,migrateSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm", - "required": true, + "related": "createRoutingFirewallRule,listRoutingFirewallRules,createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules", + "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": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "list ipv6 firewall rules by traffic type - ingress or egress", + "length": 255, + "name": "traffictype", + "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": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", + "required": false, "type": "uuid" } ], - "related": "listSystemVms,migrateSystemVm,startSystemVm,changeServiceForSystemVm", + "related": "createRoutingFirewallRule,listRoutingFirewallRules,createIpv6FirewallRule,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules", "response": [ { - "description": "the private MAC address for the system VM", - "name": "privatemacaddress", + "description": "the ending port of port forwarding rule's private port range", + "name": "privateendport", "type": "string" }, { - "description": "the system VM type", - "name": "systemvmtype", + "description": "the starting port of port forwarding rule's private port range", + "name": "privateport", "type": "string" }, { - "description": "the agent state of the system VM", - "name": "agentstate", + "description": "the vm ip address for the port forwarding rule", + "name": "vmguestip", "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", + "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": "is firewall for display to the regular user", + "name": "fordisplay", "type": "boolean" }, { - "description": "the Zone ID for the system VM", - "name": "zoneid", + "description": "the public ip address for the port forwarding rule", + "name": "ipaddress", "type": "string" }, { - "description": "the template name for the system VM", - "name": "templatename", + "description": "the id of the guest network the port forwarding rule belongs to", + "name": "networkid", "type": "string" }, { - "description": "public vlan range", - "name": "publicvlan", - "type": "list" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the Zone name for the system VM", - "name": "zonename", + "description": "the VM ID for the port forwarding rule", + "name": "virtualmachineid", "type": "string" }, + {}, { - "description": "the ID of the service offering of the system virtual machine.", - "name": "serviceofferingid", + "description": "the starting port of port forwarding rule's public port range", + "name": "publicport", "type": "string" }, { - "description": "the state of the system VM", - "name": "state", + "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 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": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + } + ], + "type": "list" + }, + {}, + { + "description": "the public ip address id for the port forwarding rule", + "name": "ipaddressid", "type": "string" }, { - "description": "the name of the system VM", - "name": "name", + "description": "the protocol of the port forwarding rule", + "name": "protocol", "type": "string" }, { - "description": "guest vlan range", - "name": "guestvlan", + "description": "the ID of the port forwarding rule", + "name": "id", "type": "string" }, { - "description": "the control state of the host for the system VM", - "name": "hostcontrolstate", + "description": "the VM name for the port forwarding rule", + "name": "virtualmachinename", "type": "string" }, { - "description": "the hostname for the system VM", - "name": "hostname", + "description": "the ending port of port forwarding rule's private port range", + "name": "publicendport", "type": "string" }, { - "description": "the number of active console sessions for the console proxy system vm", - "name": "activeviewersessions", - "type": "integer" + "description": "the VM display name for the port forwarding rule", + "name": "virtualmachinedisplayname", + "type": "string" }, { - "description": "the date and time the system VM was created", - "name": "created", - "type": "date" + "description": "the state of the rule", + "name": "state", + "type": "string" + } + ] + }, + { + "description": "Stops a system VM.", + "isasync": true, + "name": "stopSystemVm", + "params": [ + { + "description": "The ID of the system virtual machine", + "length": 255, + "name": "id", + "related": "listSystemVms,migrateSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm", + "required": true, + "type": "uuid" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "Force stop the VM (vm is marked as Stopped even when command fails to be send to the backend, otherwise a force poweroff is attempted). To be used if the caller knows the VM is stopped and should be marked as such.", + "length": 255, + "name": "forced", + "required": false, + "type": "boolean" + } + ], + "related": "listSystemVms,migrateSystemVm,startSystemVm,changeServiceForSystemVm", + "response": [ + { + "description": "true if 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 first DNS for the system VM", - "name": "dns1", + "description": "the ID of the service offering of the system virtual machine.", + "name": "serviceofferingid", "type": "string" }, { - "description": "the Pod ID for the system VM", - "name": "podid", + "description": "the template ID for the system VM", + "name": "templateid", "type": "string" }, - {}, { - "description": "the public netmask for the system VM", - "name": "publicnetmask", + "description": "the systemvm agent version", + "name": "version", "type": "string" }, { - "description": "the ID of the system VM", - "name": "id", + "description": "the Zone name for the system VM", + "name": "zonename", "type": "string" }, { @@ -12048,8 +12259,18 @@ "type": "string" }, { - "description": "the gateway for the system VM", - "name": "gateway", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the public IP address for the system VM", + "name": "publicip", + "type": "string" + }, + { + "description": "the second DNS for the system VM", + "name": "dns2", "type": "string" }, { @@ -12057,90 +12278,156 @@ "name": "podname", "type": "string" }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the ID of the system VM", + "name": "id", + "type": "string" + }, { "description": "the link local IP address for the system vm", "name": "linklocalip", "type": "string" }, { - "description": "the template ID for the system VM", - "name": "templateid", + "description": "the first DNS for the system VM", + "name": "dns1", "type": "string" }, { - "description": "the second DNS for the system VM", - "name": "dns2", + "description": "the name of the service offering of the system virtual machine.", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "the link local netmask for the system vm", + "name": "linklocalnetmask", + "type": "string" + }, + { + "description": "the public netmask for the system VM", + "name": "publicnetmask", "type": "string" }, + { + "description": "the host ID for the system VM", + "name": "hostid", + "type": "string" + }, + { + "description": "the network domain for the system VM", + "name": "networkdomain", + "type": "string" + }, + { + "description": "public vlan range", + "name": "publicvlan", + "type": "list" + }, { "description": "the last disconnected date of host", "name": "disconnected", "type": "date" }, { - "description": "the systemvm agent version", - "name": "version", + "description": "guest vlan range", + "name": "guestvlan", "type": "string" }, { - "description": "CPU arch of the system VM", - "name": "arch", + "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 private MAC address for the system VM", + "name": "privatemacaddress", "type": "string" }, { - "description": "the private IP address for the system VM", - "name": "privateip", + "description": "the hostname for the system VM", + "name": "hostname", "type": "string" }, { - "description": "the host ID for the system VM", - "name": "hostid", + "description": "the link local MAC address for the system vm", + "name": "linklocalmacaddress", "type": "string" }, { - "description": "the link local netmask for the system vm", - "name": "linklocalnetmask", + "description": "the state of the system VM", + "name": "state", "type": "string" }, { - "description": "the name of the service offering of the system virtual machine.", - "name": "serviceofferingname", + "description": "the number of active console sessions for the console proxy system vm", + "name": "activeviewersessions", + "type": "integer" + }, + { + "description": "CPU arch of the system VM", + "name": "arch", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the system VM type", + "name": "systemvmtype", + "type": "string" }, { - "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 private IP address for the system VM", + "name": "privateip", + "type": "string" + }, + { + "description": "the date and time the system VM was created", + "name": "created", + "type": "date" + }, + { + "description": "the name of the system VM", + "name": "name", "type": "string" }, {}, + { + "description": "the control state of the host for the system VM", + "name": "hostcontrolstate", + "type": "string" + }, + { + "description": "the template name for the system VM", + "name": "templatename", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the agent state of the system VM", + "name": "agentstate", "type": "string" }, { - "description": "the private netmask for the system VM", - "name": "privatenetmask", + "description": "the Pod ID for the system VM", + "name": "podid", "type": "string" } ] @@ -12154,33 +12441,33 @@ "description": "the ID of the firewall rule", "length": 255, "name": "id", - "related": "createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule", + "related": "createRoutingFirewallRule,listRoutingFirewallRules,createIpv6FirewallRule,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules", "required": true, "type": "uuid" } ], "response": [ + {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, {}, - {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ] }, @@ -12190,12 +12477,19 @@ "name": "updateVPC", "params": [ { - "description": "the id of the VPC", + "description": "the display text of the VPC", "length": 255, - "name": "id", - "related": "createVPC,listVPCs,updateVPC,createVPC,listVPCs,updateVPC,migrateVPC", - "required": true, - "type": "uuid" + "name": "displaytext", + "required": false, + "type": "string" + }, + { + "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 name of the VPC", @@ -12229,108 +12523,171 @@ "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", + "description": "the id of the VPC", "length": 255, - "name": "displaytext", - "required": false, - "type": "string" + "name": "id", + "related": "createVPC,listVPCs,updateVPC,createVPC,listVPCs,updateVPC,migrateVPC", + "required": true, + "type": "uuid" } ], "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", "response": [ { - "description": "the name of the VPC", - "name": "name", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "an alternate display text of the VPC.", - "name": "displaytext", + "description": "the id of the VPC", + "name": "id", "type": "string" }, { - "description": "the domain name of the owner", - "name": "domain", - "type": "string" + "description": "true VPC requires restart", + "name": "restartrequired", + "type": "boolean" }, { - "description": "the first IPv6 DNS for the VPC", - "name": "ip6dns1", + "description": "the second IPv6 DNS for the VPC", + "name": "ip6dns2", "type": "string" }, { - "description": "the domain id of the VPC owner", - "name": "domainid", - "type": "string" + "description": "AS NUMBER", + "name": "asnumber", + "type": "long" }, { - "description": "the name of the zone the VPC belongs to", - "name": "zonename", + "description": "the first IPv6 DNS for the VPC", + "name": "ip6dns1", "type": "string" }, + {}, { - "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": "UUID of AS NUMBER", - "name": "asnumberid", + "description": "the project id of the VPC", + "name": "projectid", "type": "string" }, { - "description": "true if VPC is region level", - "name": "regionlevelvpc", - "type": "boolean" - }, - {}, - { - "description": "if this VPC has redundant router", - "name": "redundantvpcrouter", - "type": "boolean" - }, - { - "description": "AS NUMBER", - "name": "asnumber", - "type": "long" + "description": "the network domain of the VPC", + "name": "networkdomain", + "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", + "name": "ip6routes", + "type": "set" }, { - "description": "MTU configured on the public interfaces of the VPC VR", - "name": "publicmtu", - "type": "integer" + "description": "zone id of the vpc", + "name": "zoneid", + "type": "string" }, { "description": "The routes for the VPC to ease adding route in upstream router", "name": "ip4routes", "type": "set" }, - {}, { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip6routes", - "type": "set" + "description": "the list of supported services", + "name": "service", + "response": [ + { + "description": "the service provider name", + "name": "provider", + "response": [ + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "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": "services for this provider", + "name": "servicelist", + "type": "list" + }, + { + "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": "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 project id of the VPC", - "name": "projectid", + "description": "the cidr the VPC", + "name": "cidr", "type": "string" }, { - "description": "state of the VPC. Can be Inactive/Enabled", - "name": "state", + "description": "the project name of the VPC", + "name": "project", + "type": "string" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "The IPv4 routing mode of VPC", + "name": "ip4routing", "type": "string" }, { @@ -12338,13 +12695,8 @@ "name": "tags", "response": [ { - "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" }, { @@ -12353,33 +12705,33 @@ "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the account associated with the tag", + "name": "account", "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": "tag value", - "name": "value", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -12388,36 +12740,36 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", "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": "MTU configured on the public interfaces of the VPC VR", + "name": "publicmtu", + "type": "integer" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "is VPC uses distributed router for one hop forwarding and host based network ACL's", + "name": "distributedvpcrouter", + "type": "boolean" }, { - "description": "the id of the VPC", - "name": "id", + "description": "the first IPv4 DNS for the VPC", + "name": "dns1", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the zone the VPC belongs to", + "name": "zonename", "type": "string" }, { @@ -12426,193 +12778,112 @@ "type": "string" }, { - "description": "the first IPv4 DNS for the VPC", - "name": "dns1", + "description": "vpc offering id the VPC is created from", + "name": "vpcofferingid", "type": "string" }, { - "description": "vpc offering name the VPC is created from", - "name": "vpcofferingname", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + { + "description": "the second IPv4 DNS for the VPC", + "name": "dns2", "type": "string" }, { - "description": "the second IPv6 DNS for the VPC", - "name": "ip6dns2", + "description": "an alternate display text of the VPC.", + "name": "displaytext", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the domain id of the VPC owner", + "name": "domainid", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if VPC is region level", + "name": "regionlevelvpc", + "type": "boolean" }, { - "description": "the cidr the VPC", - "name": "cidr", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "is vpc for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "The BGP peers for the VPC", + "name": "bgppeers", + "type": "set" }, { - "description": "the list of supported services", - "name": "service", - "response": [ - { - "description": "the service name", - "name": "name", - "type": "string" - }, - { - "description": "the service provider name", - "name": "provider", - "response": [ - { - "description": "state of the network provider", - "name": "state", - "type": "string" - }, - { - "description": "the provider name", - "name": "name", - "type": "string" - }, - { - "description": "services for this provider", - "name": "servicelist", - "type": "list" - }, - { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" - }, - { - "description": "uuid of the network provider", - "name": "id", - "type": "string" - }, - { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" - }, - { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" - } - ], - "type": "list" - }, - { - "description": "the list of capabilities", - "name": "capability", - "response": [ - { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" - }, - { - "description": "the capability name", - "name": "name", - "type": "string" - }, - { - "description": "the capability value", - "name": "value", - "type": "string" - } - ], - "type": "list" - } - ], - "type": "list" + "description": "if this VPC has redundant router", + "name": "redundantvpcrouter", + "type": "boolean" }, { - "description": "zone id of the vpc", - "name": "zoneid", + "description": "the domain name of the owner", + "name": "domain", "type": "string" }, { - "description": "the project name of the VPC", - "name": "project", + "description": "UUID of AS NUMBER", + "name": "asnumberid", "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": "state of the VPC. Can be Inactive/Enabled", + "name": "state", + "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 IPv4 routing mode of VPC", - "name": "ip4routing", + "description": "the domain path of the owner", + "name": "domainpath", "type": "string" }, { - "description": "The BGP peers for the VPC", - "name": "bgppeers", - "type": "set" + "description": "the name of the VPC", + "name": "name", + "type": "string" }, { "description": "the date this VPC was created", "name": "created", "type": "date" + }, + { + "description": "is vpc for display to the regular user", + "name": "fordisplay", + "type": "boolean" } ] }, { - "description": "Lists all IPv6 firewall rules", + "description": "List VM Schedules.", "isasync": false, - "name": "listIpv6FirewallRules", + "name": "listVMSchedule", "params": [ { - "description": "list ipv6 firewall rules by network ID", + "description": "ID of VM schedule", "length": 255, - "name": "networkid", - "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "enabled", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "List by keyword", "length": 255, - "name": "account", + "name": "keyword", "required": false, "type": "string" }, - { - "description": "list 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, @@ -12621,202 +12892,78 @@ "type": "integer" }, { - "description": "list ipv6 firewall rules by traffic type - ingress or egress", + "description": "Action taken by schedule", "length": 255, - "name": "traffictype", + "name": "action", "required": false, "type": "string" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "ID of VM schedule", "length": 255, - "name": "listall", + "name": "id", + "related": "createVMSchedule,listVMSchedule,updateVMSchedule", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "list only resources belonging to the domain specified", + "description": "ID of the VM for which schedule is to be defined", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", - "required": false, + "name": "virtualmachineid", + "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,createVMFromBackup,createVMFromBackup,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", + "required": true, "type": "uuid" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "", "length": 255, - "name": "fordisplay", + "name": "pagesize", "required": false, - "type": "boolean" - }, + "type": "integer" + } + ], + "related": "createVMSchedule,updateVMSchedule", + "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": "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", - "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": "the VM name for the port forwarding rule", - "name": "virtualmachinename", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "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 ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "the starting port of port forwarding rule's private port range", - "name": "privateport", - "type": "string" - }, - { - "description": "the ending port of port forwarding rule's private port range", - "name": "privateendport", - "type": "string" - }, - { - "description": "the public ip address for the port forwarding rule", - "name": "ipaddress", - "type": "string" + "description": "Date after which the schedule becomes inactive", + "name": "enddate", + "type": "date" }, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "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": "Action", + "name": "action", + "type": "action" }, { - "description": "is firewall for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "Date from which the schedule is active", + "name": "startdate", + "type": "date" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Timezone of the schedule", + "name": "timezone", "type": "string" }, {}, { - "description": "the VM ID for the port forwarding rule", - "name": "virtualmachineid", - "type": "string" + "description": "Date when the schedule was created", + "name": "created", + "type": "date" }, { - "description": "the vm ip address for the port forwarding rule", - "name": "vmguestip", + "description": "Description of VM schedule", + "name": "description", "type": "string" }, { - "description": "the id of the guest network the port forwarding rule belongs to", - "name": "networkid", + "description": "Cron formatted VM schedule", + "name": "schedule", "type": "string" }, { @@ -12825,138 +12972,19 @@ "type": "integer" }, { - "description": "the ending port of port forwarding rule's private port range", - "name": "publicendport", - "type": "string" - }, - {}, - { - "description": "the starting port of port forwarding rule's public port range", - "name": "publicport", - "type": "string" - } - ] - }, - { - "description": "List VM Schedules.", - "isasync": false, - "name": "listVMSchedule", - "params": [ - { - "description": "ID of VM schedule", - "length": 255, - "name": "enabled", - "required": false, - "type": "boolean" - }, - { - "description": "ID of the VM for which schedule is to be defined", - "length": 255, - "name": "virtualmachineid", - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", - "required": true, - "type": "uuid" - }, - { - "description": "ID of VM schedule", - "length": 255, + "description": "the ID of VM schedule", "name": "id", - "related": "createVMSchedule,listVMSchedule,updateVMSchedule", - "required": false, - "type": "uuid" - }, - { - "description": "Action taken by schedule", - "length": 255, - "name": "action", - "required": false, - "type": "string" - }, - { - "description": "", - "length": 255, - "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" - } - ], - "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": "VM schedule is enabled", "name": "enabled", "type": "boolean" }, - { - "description": "Date when the schedule was created", - "name": "created", - "type": "date" - }, - { - "description": "Cron formatted VM schedule", - "name": "schedule", - "type": "string" - }, { "description": "ID of virtual machine", "name": "virtualmachineid", "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "Action", - "name": "action", - "type": "action" - }, - { - "description": "Date from which the schedule is active", - "name": "startdate", - "type": "date" - }, - {}, - {}, - { - "description": "Description of VM schedule", - "name": "description", - "type": "string" - }, - { - "description": "the ID of VM schedule", - "name": "id", - "type": "string" - }, - { - "description": "Timezone of the schedule", - "name": "timezone", - "type": "string" } ], "since": "4.19.0" @@ -12966,13 +12994,6 @@ "isasync": true, "name": "patchSystemVm", "params": [ - { - "description": "If true, initiates copy of scripts and restart of the agent, even if the scripts version matches.To be used with ID parameter only", - "length": 255, - "name": "forced", - "required": false, - "type": "boolean" - }, { "description": "patches systemVM - CPVM/SSVM with the specified ID", "length": 255, @@ -12980,31 +13001,38 @@ "related": "listSystemVms,migrateSystemVm,startSystemVm,changeServiceForSystemVm", "required": false, "type": "uuid" + }, + { + "description": "If true, initiates copy of scripts and restart of the agent, even if the scripts version matches.To be used with ID parameter only", + "length": 255, + "name": "forced", + "required": false, + "type": "boolean" } ], "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, { "description": "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.17.0" }, @@ -13013,13 +13041,6 @@ "isasync": true, "name": "addNodesToKubernetesCluster", "params": [ - { - "description": "(optional) Vmware only, uses the CKS cluster network VR to mount the CKS ISO", - "length": 255, - "name": "mountcksisoonvr", - "required": false, - "type": "boolean" - }, { "description": "the ID of the Kubernetes cluster", "length": 255, @@ -13033,10 +13054,17 @@ "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": "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", + "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,createVMFromBackup,createVMFromBackup,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", "required": true, "type": "list" }, + { + "description": "(optional) Vmware only, uses the CKS cluster network VR to mount the CKS ISO", + "length": 255, + "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", "length": 255, @@ -13048,51 +13076,61 @@ "related": "createKubernetesCluster,startKubernetesCluster,listKubernetesClusters,scaleKubernetesCluster,upgradeKubernetesCluster", "response": [ { - "description": "the cpu cores of the Kubernetes cluster", - "name": "cpunumber", + "description": "the name of the service offering of the Kubernetes cluster", + "name": "serviceofferingname", "type": "string" }, { - "description": "URL end point for the Kubernetes cluster dashboard UI", - "name": "consoleendpoint", - "type": "string" + "description": "the size (worker nodes count) of the Kubernetes cluster", + "name": "size", + "type": "long" }, { - "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 ID of the service offering of the Kubernetes cluster", - "name": "serviceofferingid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Whether autoscaling is enabled for the cluster", - "name": "autoscalingenabled", + "description": "Indicates if the CloudStack CSI driver has been setup in the cluster", + "name": "csienabled", "type": "boolean" }, - {}, { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zonename", + "description": "the id of the Kubernetes cluster", + "name": "id", "type": "string" }, { - "description": "the name of the service offering of the control nodes on the Kubernetes cluster", - "name": "controlofferingname", + "description": "the type of the cluster", + "name": "clustertype", + "type": "clustertype" + }, + { + "description": "the name of the Kubernetes cluster", + "name": "name", "type": "string" }, { - "description": "the project name of the Kubernetes cluster", - "name": "project", + "description": "path of the domain to which the Kubernetes cluster belongs", + "name": "domainpath", "type": "string" }, { - "description": "Minimum size of the cluster", - "name": "minsize", - "type": "long" + "description": "the name of the zone of the Kubernetes cluster", + "name": "zoneid", + "type": "string" + }, + { + "description": "Public IP Address ID of the cluster", + "name": "ipaddressid", + "type": "string" }, + {}, { "description": "Public IP Address of the cluster", "name": "ipaddress", @@ -13104,64 +13142,70 @@ "type": "string" }, { - "description": "Name of CNI Configuration associated with the cluster", - "name": "cniconfigname", + "description": "keypair details", + "name": "keypair", "type": "string" }, { - "description": "the control nodes count for the Kubernetes cluster", - "name": "controlnodes", - "type": "long" + "description": "URL end point for the Kubernetes cluster", + "name": "endpoint", + "type": "string" }, { - "description": "the name of the domain in which the Kubernetes cluster exists", - "name": "domain", + "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 ID of the service offering of the worker nodes on the Kubernetes cluster", + "name": "workerofferingid", "type": "string" }, { - "description": "the state of the Kubernetes cluster", - "name": "state", - "type": "string" + "description": "the number of the etcd nodes on the Kubernetes cluster", + "name": "etcdnodes", + "type": "long" }, { - "description": "the name of the network of the Kubernetes cluster", - "name": "associatednetworkname", - "type": "string" + "description": "Maximum size of the cluster", + "name": "maxsize", + "type": "long" }, { - "description": "the name of the service offering of the etcd nodes on the Kubernetes cluster", - "name": "etcdofferingname", - "type": "string" + "description": "Public IP Addresses of the etcd nodes", + "name": "etcdips", + "type": "map" }, { - "description": "the ID of the domain in which the Kubernetes cluster exists", - "name": "domainid", - "type": "string" + "description": "the list of virtualmachine associated with this Kubernetes cluster", + "name": "virtualmachines", + "type": "list" }, { - "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 memory the Kubernetes cluster", + "name": "memory", "type": "string" }, { - "description": "Public IP Address ID of the cluster", - "name": "ipaddressid", + "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 control nodes on the Kubernetes cluster", + "name": "controlofferingname", "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 name of the Kubernetes version for the Kubernetes cluster", @@ -13169,125 +13213,114 @@ "type": "string" }, { - "description": "the ID of the service offering of the etcd nodes on the Kubernetes cluster", - "name": "etcdofferingid", + "description": "the account associated with the Kubernetes cluster", + "name": "account", "type": "string" }, { - "description": "the ID of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionid", + "description": "the name of the service offering of the worker nodes on the Kubernetes cluster", + "name": "workerofferingname", "type": "string" }, { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zoneid", + "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": "ID of CNI Configuration associated with the cluster", + "name": "cniconfigurationid", "type": "string" }, { - "description": "the memory the Kubernetes cluster", - "name": "memory", + "description": "the state of the Kubernetes cluster", + "name": "state", "type": "string" }, { - "description": "keypair details", - "name": "keypair", - "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": "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": "zonename", + "type": "string" }, { - "description": "the description of the Kubernetes cluster", - "name": "description", + "description": "the name of the domain in which the Kubernetes cluster exists", + "name": "domain", "type": "string" }, { - "description": "the account associated with the Kubernetes cluster", - "name": "account", + "description": "the name of the service offering of the etcd nodes on the Kubernetes cluster", + "name": "etcdofferingname", "type": "string" }, { - "description": "the list of virtualmachine associated with this Kubernetes cluster", - "name": "virtualmachines", - "type": "list" + "description": "the ID of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionid", + "type": "string" }, { - "description": "ID of CNI Configuration associated with the cluster", - "name": "cniconfigurationid", + "description": "the ID of the domain in which the Kubernetes cluster exists", + "name": "domainid", "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": "path of the domain to which the Kubernetes cluster belongs", - "name": "domainpath", + "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 master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", - "name": "masternodes", - "type": "long" + "description": "the cpu cores of the Kubernetes cluster", + "name": "cpunumber", + "type": "string" }, { - "description": "the type of the cluster", - "name": "clustertype", - "type": "clustertype" + "description": "Whether autoscaling is enabled for the cluster", + "name": "autoscalingenabled", + "type": "boolean" }, { - "description": "the name of the Kubernetes cluster", - "name": "name", + "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", - "name": "endpoint", + "description": "the ID of the service offering of the Kubernetes cluster", + "name": "serviceofferingid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the control nodes count for the Kubernetes cluster", + "name": "controlnodes", + "type": "long" }, { - "description": "the name of the service offering of the Kubernetes cluster", - "name": "serviceofferingname", - "type": "string" + "description": "Minimum size of the cluster", + "name": "minsize", + "type": "long" }, { - "description": "the id of the Kubernetes cluster", - "name": "id", + "description": "the name of the network of the Kubernetes cluster", + "name": "associatednetworkname", "type": "string" }, { "description": "the project id of the Kubernetes cluster", "name": "projectid", "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" } ], "since": "4.21.0" @@ -13298,93 +13331,89 @@ "name": "listVolumesMetrics", "params": [ { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "makes the API's response contains only the resource count", "length": 255, - "name": "displayvolume", + "name": "retrieveonlyresourcecount", "required": false, - "since": "4.4", "type": "boolean" }, { - "description": "List resources by tags (key/value pairs)", - "length": 255, - "name": "tags", - "required": false, - "type": "map" - }, - { - "description": "the cluster id the disk volume belongs to", - "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", - "required": false, - "type": "uuid" - }, - { - "description": "state of the volume. Possible values are: Ready, Allocated, Destroy, Expunging, Expunged.", + "description": "List by keyword", "length": 255, - "name": "state", + "name": "keyword", "required": false, "type": "string" }, { - "description": "list volumes by disk offering of a service offering. If both service offering and disk offering are passed, service offering is ignored", + "description": "", "length": 255, - "name": "serviceofferingid", - "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", + "name": "page", "required": false, - "since": "4.19.1", - "type": "uuid" + "type": "integer" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "list system VMs; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "isrecursive", + "name": "listsystemvms", "required": false, + "since": "4.18", "type": "boolean" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "listall", + "name": "isrecursive", "required": false, "type": "boolean" }, { - "description": "list only resources belonging to the domain specified", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, "type": "uuid" }, { - "description": "list volumes by disk offering", + "description": "the ID of the virtual machine", "length": 255, - "name": "diskofferingid", - "related": "createDiskOffering,updateDiskOffering,listDiskOfferings", + "name": "virtualmachineid", + "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,createVMFromBackup,createVMFromBackup,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", "required": false, - "since": "4.4", "type": "uuid" }, { - "description": "the ID of the storage pool, available to ROOT admin only", + "description": "list only volumes that are encrypted", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "name": "isencrypted", "required": false, - "since": "4.3", - "type": "string" + "since": "4.19.1", + "type": "boolean" }, { "description": "the IDs of the volumes, mutually exclusive with id", "length": 255, "name": "ids", - "related": "attachVolume,checkVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", + "related": "importVolume,attachVolume,checkVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", "required": false, "since": "4.9", "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.", + "length": 255, + "name": "listall", + "required": false, + "type": "boolean" + }, + { + "description": "list volumes on specified host", + "length": 255, + "name": "hostid", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost", + "required": false, + "type": "uuid" + }, { "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, @@ -13393,40 +13422,42 @@ "type": "string" }, { - "description": "makes the API's response contains only the resource count", + "description": "the ID of the storage pool, available to ROOT admin only", "length": 255, - "name": "retrieveonlyresourcecount", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", "required": false, - "type": "boolean" + "since": "4.3", + "type": "string" }, { - "description": "the pod id the disk volume belongs to", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "podid", - "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", + "name": "displayvolume", "required": false, - "type": "uuid" + "since": "4.4", + "type": "boolean" }, { - "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" }, { - "description": "", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "pagesize", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "the ID of the disk volume", + "description": "the cluster id the disk volume belongs to", "length": 255, - "name": "id", - "related": "attachVolume,checkVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", + "name": "clusterid", + "related": "addCluster,updateCluster", "required": false, "type": "uuid" }, @@ -13438,153 +13469,212 @@ "type": "string" }, { - "description": "the ID of the virtual machine", + "description": "the pod id the disk volume belongs to", "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": "podid", + "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", "required": false, "type": "uuid" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "the name of the disk volume", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "name", "required": false, - "type": "uuid" + "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": "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": "hostid", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,addBaremetalHost", + "name": "serviceofferingid", + "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", "required": false, + "since": "4.19.1", "type": "uuid" }, { - "description": "the name of the disk volume", + "description": "the ID of the disk volume", "length": 255, - "name": "name", + "name": "id", + "related": "importVolume,attachVolume,checkVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "List by keyword", + "description": "the ID of the availability zone", "length": 255, - "name": "keyword", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the ID of the availability zone", + "description": "list volumes by disk offering", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "diskofferingid", + "related": "createDiskOffering,updateDiskOffering,listDiskOfferings", "required": false, + "since": "4.4", "type": "uuid" } ], "related": "", "response": [ { - "description": "cluster id of the volume", - "name": "clusterid", + "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": "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", + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", "type": "long" }, { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" + "description": "the list of resource tags associated", + "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 project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the 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": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + } + ], + "type": "set" }, { - "description": "name of the disk volume", - "name": "name", - "type": "string" + "description": "size of the disk volume", + "name": "size", + "type": "long" }, { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", - "type": "long" + "description": "the date the disk volume was created", + "name": "created", + "type": "date" }, { - "description": "ID of the disk volume", - "name": "id", + "description": "disk size in GiB", + "name": "sizegb", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "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 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" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", - "type": "string" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", + "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": "details for the volume repair result, they may vary for different hypervisors", + "name": "volumerepairresult", + "type": "map" }, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", + "description": "path of the Domain the disk volume belongs to", + "name": "domainpath", "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": "name of the primary storage hosting the disk volume", - "name": "storage", + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", "type": "string" }, { - "description": "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": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", @@ -13592,29 +13682,19 @@ "type": "string" }, { - "description": "size of the disk volume", - "name": "size", - "type": "long" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the chain info of the volume", - "name": "chaininfo", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "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", - "type": "string" + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" }, { "description": "max iops of the disk volume", @@ -13622,18 +13702,13 @@ "type": "long" }, { - "description": "the domain associated with the disk volume", - "name": "domain", - "type": "string" - }, - { - "description": "the state of the disk volume", - "name": "state", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": "the status of the volume", + "name": "status", "type": "string" }, { @@ -13642,78 +13717,73 @@ "type": "boolean" }, { - "description": "disk size in GiB", - "name": "sizegb", + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", "type": "string" }, { - "description": "true if volume has delete protection.", - "name": "deleteprotection", - "type": "boolean" + "description": "the account associated with the disk volume", + "name": "account", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "type": "long" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "cluster id of the volume", + "name": "clusterid", "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": "the bytes actually consumed on disk", - "name": "physicalsize", - "type": "long" + "description": "name of the disk offering", + "name": "diskofferingname", + "type": "string" }, { - "description": "shared or local storage", - "name": "storagetype", + "description": "id of the virtual machine", + "name": "virtualmachineid", "type": "string" }, { - "description": "min iops of the disk volume", - "name": "miniops", + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", "type": "long" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { - "description": "the total disk iops", - "name": "diskiopstotal", - "type": "long" - }, - { - "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 ID of the domain associated with the disk volume", - "name": "domainid", + "description": "the state of the disk volume", + "name": "state", "type": "string" }, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", + "description": "true if volume has delete protection.", + "name": "deleteprotection", "type": "boolean" }, { - "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 path of the volume", - "name": "path", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { @@ -13722,212 +13792,175 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "pod name of the volume", + "name": "podname", "type": "string" }, { - "description": "name of the virtual machine", - "name": "vmname", - "type": "string" + "description": "details for the volume check result, they may vary for different hypervisors", + "name": "volumecheckresult", + "type": "map" }, { - "description": "pod id of the volume", - "name": "podid", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "type of the virtual machine", - "name": "vmtype", + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, {}, { - "description": "the project name of the vpn", - "name": "project", + "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 project id of the vpn", - "name": "projectid", + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" }, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", + "description": "min iops of the disk volume", + "name": "miniops", "type": "long" }, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", + "description": "type of the virtual machine", + "name": "vmtype", "type": "string" }, { - "description": "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": "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": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", "type": "boolean" }, { - "description": "path of the Domain the disk volume belongs to", - "name": "domainpath", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" }, { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", + "description": "the bytes actually consumed on disk", + "name": "physicalsize", "type": "long" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - } - ], - "type": "set" + "description": "the format of the disk encryption if applicable", + "name": "encryptformat", + "type": "string" }, { - "description": "the status of the volume", - "name": "status", + "description": "ID of the disk volume", + "name": "id", "type": "string" }, + { + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", + "type": "long" + }, { "description": "provisioning type used to create volumes.", "name": "provisioningtype", "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": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", + "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": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", - "type": "string" + "description": "the total disk iops", + "name": "diskiopstotal", + "type": "long" }, { - "description": "the format of the disk encryption if applicable", - "name": "encryptformat", + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", "type": "string" }, { - "description": "ID of the availability zone", - "name": "zoneid", + "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 read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", + "type": "long" + }, + { + "description": "state of the virtual machine", + "name": "vmstate", + "type": "string" }, { "description": "the bytes allocated", "name": "virtualsize", "type": "long" }, - {}, { - "description": "name of the availability zone", - "name": "zonename", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "pod name of the volume", - "name": "podname", + "description": "cluster name where the volume is allocated", + "name": "clustername", "type": "string" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "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 domain associated with the disk volume", + "name": "domain", + "type": "string" + }, + { + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, { @@ -13960,22 +13993,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": "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" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ], "since": "4.13" @@ -13986,26 +14019,26 @@ "name": "listSslCerts", "params": [ { - "description": "Load balancer rule ID", + "description": "ID of SSL certificate", "length": 255, - "name": "lbruleid", - "related": "createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,updateIpv6FirewallRule", + "name": "certid", + "related": "uploadSslCert,listSslCerts", "required": false, "type": "uuid" }, { - "description": "Project that owns the SSL certificate", + "description": "Load balancer rule ID", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "lbruleid", + "related": "createRoutingFirewallRule,listRoutingFirewallRules,createIpv6FirewallRule,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules", "required": false, "type": "uuid" }, { - "description": "ID of SSL certificate", + "description": "Project that owns the SSL certificate", "length": 255, - "name": "certid", - "related": "uploadSslCert,listSslCerts", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, "type": "uuid" }, @@ -14021,28 +14054,23 @@ "related": "uploadSslCert", "response": [ { - "description": "certificate chain", - "name": "certchain", + "description": "name", + "name": "name", "type": "string" }, { - "description": "List of loabalancers this certificate is bound to", - "name": "loadbalancerrulelist", - "type": "list" - }, - { - "description": "SSL certificate ID", - "name": "id", + "description": "certificate", + "name": "certificate", "type": "string" }, { - "description": "the project id of the certificate", - "name": "projectid", + "description": "the domain id of the network owner", + "name": "domainid", "type": "string" }, { - "description": "name", - "name": "name", + "description": "certificate fingerprint", + "name": "fingerprint", "type": "string" }, { @@ -14051,35 +14079,40 @@ "type": "string" }, { - "description": "the domain name of the network owner", - "name": "domain", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the project name of the certificate", "name": "project", "type": "string" }, + { + "description": "List of loabalancers this certificate is bound to", + "name": "loadbalancerrulelist", + "type": "list" + }, {}, { - "description": "certificate fingerprint", - "name": "fingerprint", + "description": "the domain name of the network owner", + "name": "domain", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "SSL certificate ID", + "name": "id", + "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": "certificate chain", + "name": "certchain", "type": "string" }, { @@ -14094,20 +14127,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, @@ -14123,6 +14142,13 @@ "required": false, "type": "boolean" }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, { "description": "list only resources belonging to the domain specified", "length": 255, @@ -14132,25 +14158,26 @@ "type": "uuid" }, { - "description": "list gateways by ip address", + "description": "list gateways by state", "length": 255, - "name": "ipaddress", + "name": "state", "required": false, "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "list gateways by ip address", "length": 255, - "name": "account", + "name": "ipaddress", "required": false, "type": "string" }, { - "description": "list gateways by vlan", + "description": "list gateways by vpc", "length": 255, - "name": "vlan", + "name": "vpcid", + "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", "required": false, - "type": "string" + "type": "uuid" }, { "description": "", @@ -14160,11 +14187,11 @@ "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": "", "length": 255, - "name": "listall", + "name": "pagesize", "required": false, - "type": "boolean" + "type": "integer" }, { "description": "list objects by project; if projectid=-1 lists All VMs", @@ -14175,48 +14202,69 @@ "type": "uuid" }, { - "description": "list gateways by vpc", + "description": "list gateways by vlan", "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "name": "vlan", "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": "pagesize", + "name": "listall", "required": false, - "type": "integer" + "type": "boolean" + }, + { + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, + "type": "string" } ], "related": "createPrivateGateway,createPrivateGateway,listPrivateGateways", "response": [ + { + "description": "the name of the Network associated with this private gateway", + "name": "associatednetwork", + "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": "the gateway", - "name": "gateway", + "description": "the private gateway's ip address", + "name": "ipaddress", "type": "string" }, { - "description": "the project id of the private gateway", - "name": "projectid", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the project name of the private gateway", + "name": "project", "type": "string" }, { - "description": "the private gateway's ip address", - "name": "ipaddress", + "description": "the id of the private gateway", + "name": "id", "type": "string" }, { - "description": "ACL name set for private gateway", - "name": "aclname", + "description": "the name of the zone the private gateway belongs to", + "name": "zonename", + "type": "string" + }, + { + "description": "the account associated with the private gateway", + "name": "account", "type": "string" }, { @@ -14224,11 +14272,6 @@ "name": "jobstatus", "type": "integer" }, - { - "description": "zone id of the private gateway", - "name": "zoneid", - "type": "string" - }, { "description": "the ID of the Network associated with this private gateway", "name": "associatednetworkid", @@ -14240,58 +14283,53 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "ACL name set for private gateway", + "name": "aclname", "type": "string" }, { - "description": "the private gateway's netmask", - "name": "netmask", + "description": "path of the domain to which the private gateway belongs", + "name": "domainpath", "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 netmask", + "name": "netmask", "type": "string" }, { - "description": "the project name of the private gateway", - "name": "project", + "description": "the ID of the domain associated with the private gateway", + "name": "domainid", "type": "string" }, { - "description": "the id of the private gateway", - "name": "id", + "description": "the gateway", + "name": "gateway", "type": "string" }, { - "description": "the name of the zone the private gateway belongs to", - "name": "zonename", + "description": "zone id of the private gateway", + "name": "zoneid", "type": "string" }, { - "description": "the account associated with the private gateway", - "name": "account", + "description": "the domain associated with the private gateway", + "name": "domain", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "ACL Id set for private gateway", - "name": "aclid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "VPC id the private gateway belongs to", - "name": "vpcid", + "description": "VPC name the private gateway belongs to", + "name": "vpcname", "type": "string" }, { @@ -14300,24 +14338,19 @@ "type": "string" }, { - "description": "the domain associated with the private gateway", - "name": "domain", - "type": "string" - }, - { - "description": "State of the gateway, can be Creating, Ready, Deleting", - "name": "state", + "description": "ACL Id set for private gateway", + "name": "aclid", "type": "string" }, { - "description": "the ID of the domain associated with the private gateway", - "name": "domainid", + "description": "the project id of the private gateway", + "name": "projectid", "type": "string" }, { - "description": "path of the domain to which the private gateway belongs", - "name": "domainpath", - "type": "string" + "description": "Source Nat enable status", + "name": "sourcenatsupported", + "type": "boolean" } ] }, @@ -14326,13 +14359,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,63 +14366,20 @@ "related": "listNics", "required": true, "type": "uuid" - } - ], - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", - "response": [ - { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" - }, - { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", - "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": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", - "type": "string" - }, - { - "description": "State of the Service from LB rule", - "name": "servicestate", - "type": "string" - }, - { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" - }, - { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "the name of the vgpu profile to which service offering is linked", - "name": "vgpuprofilename", + "description": "Secondary IP Address", + "length": 255, + "name": "ipaddress", + "required": false, "type": "string" - }, + } + ], + "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,createVMFromBackup,createVMFromBackup,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", + "response": [ { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { @@ -14405,476 +14388,186 @@ "type": "long" }, { - "description": "OS type id of the vm", - "name": "ostypeid", - "type": "string" - }, - { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", - "type": "string" + "description": "the maximum number of display heads", + "name": "maxheads", + "type": "long" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "the password (if exists) of the virtual machine", + "name": "password", "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", - "type": "long" + "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": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", - "type": "string" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "description": "the state of the virtual machine", - "name": "state", - "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", + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", "type": "string" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", - "type": "string" + "description": "Instance lease duration in days", + "name": "leaseduration", + "type": "integer" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "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", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "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 total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "description": "the group name of the virtual machine", - "name": "group", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "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 virtual machine", + "name": "id", "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 name of the security group", - "name": "name", - "type": "string" - }, - { - "description": "the description of the security group", + "description": "the description of the affinity group", "name": "description", "type": "string" }, { - "description": "the ID of the security group", + "description": "the ID of the affinity group", "name": "id", "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": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" }, { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" }, { - "description": "the account owning the security group", - "name": "account", + "description": "the domain name of the affinity group", + "name": "domain", "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": "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 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 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": "the ID of the domain associated with the tag", - "name": "domainid", - "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": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the 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", - "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - } - ], - "type": "set" + "description": "the project name of the affinity group", + "name": "project", + "type": "string" }, { - "description": "the project id of the group", - "name": "projectid", + "description": "the domain ID of the affinity group", + "name": "domainid", "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 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", - "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 id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - } - ], - "type": "set" + "description": "the type of the affinity group", + "name": "type", + "type": "string" }, { - "description": "the domain ID of the security group", - "name": "domainid", + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", - "response": [ - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the 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": "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 project name where tag belongs to", - "name": "project", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the 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 project ID of the affinity group", + "name": "projectid", + "type": "string" }, { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" + "description": "the account owning the affinity group", + "name": "account", + "type": "string" }, { - "description": "the project name of the group", - "name": "project", + "description": "the name of the affinity group", + "name": "name", "type": "string" } ], "type": "set" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", - "type": "string" + "description": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" + }, + { + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { "description": "the memory used by the VM in KiB", @@ -14882,232 +14575,140 @@ "type": "long" }, { - "description": "the project name of the vm", - "name": "project", - "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": "publicipid", "type": "string" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "User VM type", - "name": "vmtype", - "type": "string" + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "the group name of the virtual machine", + "name": "group", + "type": "string" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "CPU arch of the VM", - "name": "arch", + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "the project name of the vm", + "name": "project", + "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "the id of userdata used for the VM", + "name": "userdataid", + "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", + "type": "string" }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "resource type", - "name": "resourcetype", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "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": "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" }, { - "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 number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" - }, - { - "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": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" - }, - { - "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 group ID of the virtual machine", - "name": "groupid", - "type": "string" - }, - { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - {}, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", + "description": "device ID of the root volume", + "name": "rootdeviceid", "type": "long" }, { - "description": "true if vm has delete protection.", - "name": "deleteprotection", - "type": "boolean" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, { "description": "the list of nics associated with vm", "name": "nic", "response": [ { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" - }, - { - "description": "the 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", + "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 isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { "description": "device id for the network when plugged into the virtual machine", @@ -15115,33 +14716,33 @@ "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": "the ip address of the nic", + "name": "ipaddress", + "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { @@ -15150,23 +14751,23 @@ "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 vm to which the nic belongs", - "name": "virtualmachineid", + "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": "the isolation uri of the nic", + "name": "isolationuri", "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" }, { @@ -15175,18 +14776,8 @@ "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": "Type of adapter if available", - "name": "adaptertype", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { @@ -15195,381 +14786,43 @@ "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 type of the nic", - "name": "type", + "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", + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", "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", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - } - ], - "type": "set" - }, - { - "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 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 ID of the vgpu profile to which service offering is linked", - "name": "vgpuprofileid", - "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 id of userdata used for the VM", - "name": "userdataid", - "type": "string" - }, - { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", - "type": "string" - }, - { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", - "type": "string" - }, - { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" - }, - { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" - }, - { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "Base64 string containing the user data", - "name": "userdata", - "type": "string" - }, - { - "description": "the ID of the gpu card to which service offering is linked", - "name": "gpucardid", - "type": "string" - }, - { - "description": "the maximum Y resolution", - "name": "maxresolutiony", - "type": "long" - }, - { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "type": "string" - }, - { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the project id of the vm", - "name": "projectid", - "type": "string" - }, - { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", - "type": "string" - }, - { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", - "type": "string" - }, - { - "description": "the account associated with the virtual machine", - "name": "account", - "type": "string" - }, - { - "description": "Os type ID of the virtual machine", - "name": "guestosid", - "type": "string" - }, - { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "description": "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", + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", "type": "list" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, - { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", - "type": "string" - }, - { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" - }, - { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", - "type": "string" - }, - { - "description": "the name of the gpu card to which service offering is linked", - "name": "gpucardname", - "type": "string" - }, - { - "description": "ssh key-pairs", - "name": "keypairs", - "type": "string" - }, - { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", - "type": "string" - }, - { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" - }, - { - "description": "the format of the template for the virtual machine", - "name": "templateformat", - "type": "string" - }, - { - "description": "OS name of the vm", - "name": "osdisplayname", - "type": "string" - }, - { - "description": "Guest vm Boot Mode", - "name": "bootmode", - "type": "string" - }, - { - "description": "the maximum number of display heads", - "name": "maxheads", - "type": "long" - }, - {}, - { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "the password (if exists) of the virtual machine", - "name": "password", - "type": "string" - }, - { - "description": "Instance lease expiry date", - "name": "leaseexpirydate", - "type": "date" - }, - { - "description": "the maximum X resolution", - "name": "maxresolutionx", - "type": "long" - }, - { - "description": "the name of userdata used for the VM", - "name": "userdataname", - "type": "string" - } - ] - }, - { - "description": "Starts an existing internal lb vm.", - "isasync": true, - "name": "startInternalLoadBalancerVM", - "params": [ - { - "description": "the ID of the internal lb vm", - "length": 255, - "name": "id", - "related": "destroyRouter,listRouters,rebootRouter,stopRouter,changeServiceForRouter,stopInternalLoadBalancerVM,startInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", - "required": true, - "type": "uuid" - } - ], - "related": "destroyRouter,listRouters,rebootRouter,stopRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", - "response": [ - { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", - "type": "string" - }, - { - "description": "the guest MAC address for the router", - "name": "guestmacaddress", - "type": "string" - }, - { - "description": "the list of nics associated with the router", - "name": "nic", - "response": [ { "description": "the ID of the corresponding network", "name": "networkid", "type": "string" }, { - "description": "the 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 name of the corresponding network", - "name": "networkname", - "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", - "type": "list" - }, - { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { @@ -15578,33 +14831,8 @@ "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the ID of the nic", - "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": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { @@ -15612,494 +14840,1228 @@ "name": "ip6gateway", "type": "string" }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, { "description": "the Secondary ipv4 addr of nic", "name": "secondaryip", "type": "list" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "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": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", "type": "integer" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" } ], "type": "set" }, { - "description": "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": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the Zone ID for the router", - "name": "zoneid", - "type": "string" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "the version of scripts", - "name": "scriptsversion", - "type": "string" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "the version of the code / software in the router", - "name": "softwareversion", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "the host ID for the router", - "name": "hostid", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "the guest netmask for the router", - "name": "guestnetmask", - "type": "string" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "description": "the domain associated with the router", - "name": "domain", + "description": "OS name of the vm", + "name": "osdisplayname", "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 ID of the corresponding guest network", - "name": "guestnetworkid", - "type": "string" + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "VPC the router belongs to", - "name": "vpcid", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "the link local IP address for the router", - "name": "linklocalip", + "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 router", - "name": "id", + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the first DNS for the router", - "name": "dns1", - "type": "string" + "description": "the maximum X resolution", + "name": "maxresolutionx", + "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 link local MAC address for the router", - "name": "linklocalmacaddress", + "description": "CPU arch of the VM", + "name": "arch", "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the network domain for the router", - "name": "networkdomain", - "type": "string" + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, { - "description": "the Zone name for the router", - "name": "zonename", - "type": "string" + "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": "path of the domain in which the virtual machine exists", + "name": "domainpath", "type": "string" }, { - "description": "the version of template", - "name": "version", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "the control state of the host for the router", - "name": "hostcontrolstate", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "the state of redundant virtual router", - "name": "redundantstate", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "the public MAC address for the router", - "name": "publicmacaddress", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "the public netmask for the router", - "name": "publicnetmask", - "type": "string" + "description": "the video RAM size in MB", + "name": "videoram", + "type": "long" }, { - "description": "the Pod ID for the router", - "name": "podid", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "the name of VPC the router belongs to", - "name": "vpcname", + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", "type": "string" }, { - "description": "role of the domain router", - "name": "role", - "type": "string" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the template ID for the router", - "name": "templateid", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "CPU arch of the router", - "name": "arch", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the Pod name for the router", - "name": "podname", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "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", - "name": "success", - "type": "boolean" - }, - { - "description": "the date this VPC was created", - "name": "lastupdated", - "type": "date" - }, - { - "description": "detailed response generated on running health check", - "name": "details", - "type": "string" - }, - { - "description": "the type of the health check - basic or advanced", - "name": "checktype", - "type": "string" - } - ], - "type": "list" + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" }, { - "description": "the guest IP address for the router", - "name": "guestipaddress", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "path of the Domain the router belongs to", - "name": "domainpath", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, - {}, { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "the gateway for the router", - "name": "gateway", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "the second DNS for the router", - "name": "dns2", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, {}, { - "description": "the state of the router", - "name": "state", - "type": "state" - }, - { - "description": "the hostname for the router", - "name": "hostname", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "the template name for the router", - "name": "templatename", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the ID of the corresponding public network", - "name": "publicnetworkid", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "if this router is an redundant virtual router", - "name": "isredundantrouter", - "type": "boolean" + "description": "Base64 string containing the user data", + "name": "userdata", + "type": "string" }, + {}, { - "description": "the account associated with the router", - "name": "account", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "true if any health checks had failed", - "name": "healthchecksfailed", + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", "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", + "description": "the memory allocated for the virtual machine", + "name": "memory", "type": "integer" }, { - "description": "the name of the router", - "name": "name", - "type": "string" + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" }, + {}, { - "description": "the public IP address for the router", - "name": "publicip", + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", "type": "string" }, { - "description": "the domain ID associated with the router", - "name": "domainid", + "description": "the format of the template for the virtual machine", + "name": "templateformat", "type": "string" - } - ] - }, - { - "description": "Updates a disk offering.", - "isasync": false, - "name": "updateDiskOffering", - "params": [ + }, { - "description": "length (in seconds) of the burst", - "length": 255, - "name": "iopswriteratemaxlength", - "required": false, - "since": "4.15", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", "type": "long" }, { - "description": "an optional field, whether to display the offering to the end user or not.", - "length": 255, - "name": "displayoffering", - "required": false, - "type": "boolean" + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" }, { - "description": "the ID of the containing zone(s) as comma separated string, all for all zones offerings", - "length": 255, - "name": "zoneid", - "required": false, - "since": "4.13", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "length (in seconds) of the burst", - "length": 255, - "name": "byteswriteratemaxlength", - "required": false, - "since": "4.15", + "description": "the maximum Y resolution", + "name": "maxresolutiony", "type": "long" }, { - "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", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "bytes write rate of the disk offering", - "length": 255, - "name": "byteswriterate", - "required": false, - "since": "4.15", - "type": "long" + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" }, { - "description": "length (in seconds) of the burst", - "length": 255, - "name": "iopsreadratemaxlength", - "required": false, - "since": "4.15", + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", "type": "long" }, { - "description": "state of the disk offering", - "length": 255, - "name": "state", - "required": false, + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", "type": "string" }, { - "description": "burst bytes read rate of the disk offering", - "length": 255, - "name": "bytesreadratemax", - "required": false, - "since": "4.15", - "type": "long" - }, - { - "description": "updates name of the disk offering with this value", - "length": 255, - "name": "name", - "required": false, + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "the cache mode to use for this disk offering", - "length": 255, - "name": "cachemode", - "required": false, - "since": "4.15", + "description": "User VM type", + "name": "vmtype", "type": "string" }, { - "description": "updates alternate display text of the disk offering with this value", - "length": 4096, - "name": "displaytext", - "required": false, + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "comma-separated list of tags for the disk offering, tags should match with existing storage pool tags", + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", + "response": [ + { + "description": "path of the Domain the security group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the 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 code for the ICMP message response", + "name": "icmpcode", + "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": "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": "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": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + } + ], + "type": "set" + }, + { + "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 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" + } + ], + "type": "set" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the 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": "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" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "the project name of the group", + "name": "project", + "type": "string" + }, + { + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "the list of egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "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": "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": "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 ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + } + ], + "type": "set" + }, + { + "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 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": "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 name of the security group", + "name": "name", + "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 ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "the description of the security group", + "name": "description", + "type": "string" + } + ], + "type": "set" + }, + { + "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 name of the host for the virtual machine", + "name": "hostname", + "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": "tags", + "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "VPC the router belongs to", + "name": "vpcid", + "type": "string" + }, + { + "description": "the control state of the host for the router", + "name": "hostcontrolstate", + "type": "string" + }, + { + "description": "the template ID for the router", + "name": "templateid", + "type": "string" + }, + { + "description": "true if any health checks had failed", + "name": "healthchecksfailed", + "type": "boolean" + }, + { + "description": "the domain ID associated with the router", + "name": "domainid", + "type": "string" + }, + { + "description": "the project id of the ipaddress", + "name": "projectid", + "type": "string" + }, + { + "description": "the link local IP address for the router", + "name": "linklocalip", + "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": "role of the domain router", + "name": "role", + "type": "string" + }, + { + "description": "the version of template", + "name": "version", + "type": "string" + }, + { + "description": "the date and time the router was created", + "name": "created", + "type": "date" + }, + { + "description": "the public netmask for the router", + "name": "publicnetmask", + "type": "string" + }, + { + "description": "the name of VPC the router belongs to", + "name": "vpcname", + "type": "string" + }, + { + "description": "the name of the corresponding guest network", + "name": "guestnetworkname", + "type": "string" + }, + { + "description": "the second DNS for the router", + "name": "dns2", + "type": "string" + }, + { + "description": "the link local MAC address for the router", + "name": "linklocalmacaddress", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the ID of the corresponding public network", + "name": "publicnetworkid", + "type": "string" + }, + { + "description": "the guest IP address for the router", + "name": "guestipaddress", + "type": "string" + }, + { + "description": "the version of the code / software in the router", + "name": "softwareversion", + "type": "string" + }, + { + "description": "the template name for the router", + "name": "templatename", + "type": "string" + }, + { + "description": "the Zone ID for the router", + "name": "zoneid", + "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 UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the id of the router", + "name": "id", + "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 gateway for the router", + "name": "gateway", + "type": "string" + }, + { + "description": "true if the router template requires upgrader", + "name": "requiresupgrade", + "type": "boolean" + }, + { + "description": "the account associated with the router", + "name": "account", + "type": "string" + }, + { + "description": "the 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": "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 ID of the corresponding link local network", + "name": "linklocalnetworkid", + "type": "string" + }, + { + "description": "the domain associated with the router", + "name": "domain", + "type": "string" + }, + { + "description": "the list of nics associated with the router", + "name": "nic", + "response": [ + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "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": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "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" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "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": "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 isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "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": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + } + ], + "type": "set" + }, + {}, + { + "description": "the first IPv6 DNS for the router", + "name": "ip6dns1", + "type": "string" + }, + { + "description": "the state of the router", + "name": "state", + "type": "state" + }, + { + "description": "the public MAC address for the router", + "name": "publicmacaddress", + "type": "string" + }, + { + "description": "the project name of the address", + "name": "project", + "type": "string" + }, + { + "description": "the network domain for the router", + "name": "networkdomain", + "type": "string" + }, + { + "description": "the public IP address for the router", + "name": "publicip", + "type": "string" + }, + { + "description": "the Pod ID for the router", + "name": "podid", + "type": "string" + }, + { + "description": "the state of redundant virtual router", + "name": "redundantstate", + "type": "string" + }, + { + "description": "the version of scripts", + "name": "scriptsversion", + "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": "detailed response generated on running health check", + "name": "details", + "type": "string" + }, + { + "description": "the type of the health check - basic or advanced", + "name": "checktype", + "type": "string" + }, + { + "description": "result of the health check if available", + "name": "success", + "type": "boolean" + }, + { + "description": "the name of the health check on the router", + "name": "checkname", + "type": "string" + }, + { + "description": "the date this VPC was created", + "name": "lastupdated", + "type": "date" + } + ], + "type": "list" + }, + { + "description": "the host ID for the router", + "name": "hostid", + "type": "string" + }, + { + "description": "CPU arch of the router", + "name": "arch", + "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", + "type": "string" + }, + { + "description": "the Pod name for the router", + "name": "podname", + "type": "string" + }, + { + "description": "the guest MAC address for the router", + "name": "guestmacaddress", + "type": "string" + } + ] + }, + { + "description": "Updates a disk offering.", + "isasync": false, + "name": "updateDiskOffering", + "params": [ + { + "description": "length (in seconds) of the burst", + "length": 255, + "name": "bytesreadratemaxlength", + "required": false, + "since": "4.15", + "type": "long" + }, + { + "description": "bytes read rate of the disk offering", + "length": 255, + "name": "bytesreadrate", "required": false, "since": "4.15", + "type": "long" + }, + { + "description": "the ID of the containing zone(s) as comma separated string, all for all zones offerings", + "length": 255, + "name": "zoneid", + "required": false, + "since": "4.13", "type": "string" }, { - "description": "io requests read rate of the disk offering", + "description": "burst bytes write rate of the disk offering", "length": 255, - "name": "iopsreadrate", + "name": "byteswriteratemax", "required": false, "since": "4.15", "type": "long" @@ -16107,18 +16069,18 @@ { "description": "length (in seconds) of the burst", "length": 255, - "name": "bytesreadratemaxlength", + "name": "byteswriteratemaxlength", "required": false, "since": "4.15", "type": "long" }, { - "description": "bytes read rate of the disk offering", + "description": "comma-separated list of tags for the disk offering, tags should match with existing storage pool tags", "length": 255, - "name": "bytesreadrate", + "name": "tags", "required": false, "since": "4.15", - "type": "long" + "type": "string" }, { "description": "burst io requests write rate of the disk offering", @@ -16128,6 +16090,37 @@ "since": "4.15", "type": "long" }, + { + "description": "state of the disk offering", + "length": 255, + "name": "state", + "required": false, + "type": "string" + }, + { + "description": "burst requests read rate of the disk offering", + "length": 255, + "name": "iopsreadratemax", + "required": false, + "since": "4.15", + "type": "long" + }, + { + "description": "the cache mode to use for this disk offering", + "length": 255, + "name": "cachemode", + "required": false, + "since": "4.15", + "type": "string" + }, + { + "description": "length (in seconds) of the burst", + "length": 255, + "name": "iopsreadratemaxlength", + "required": false, + "since": "4.15", + "type": "long" + }, { "description": "sort key of the disk offering, integer", "length": 255, @@ -16136,9 +16129,47 @@ "type": "integer" }, { - "description": "burst bytes write rate of the disk offering", + "description": "io requests write rate of the disk offering", "length": 255, - "name": "byteswriteratemax", + "name": "iopswriterate", + "required": false, + "since": "4.15", + "type": "long" + }, + { + "description": "bytes write rate of the disk offering", + "length": 255, + "name": "byteswriterate", + "required": false, + "since": "4.15", + "type": "long" + }, + { + "description": "updates name of the disk offering with this value", + "length": 255, + "name": "name", + "required": false, + "type": "string" + }, + { + "description": "length (in seconds) of the burst", + "length": 255, + "name": "iopswriteratemaxlength", + "required": false, + "since": "4.15", + "type": "long" + }, + { + "description": "updates alternate display text of the disk offering with this value", + "length": 4096, + "name": "displaytext", + "required": false, + "type": "string" + }, + { + "description": "io requests read rate of the disk offering", + "length": 255, + "name": "iopsreadrate", "required": false, "since": "4.15", "type": "long" @@ -16152,33 +16183,55 @@ "type": "uuid" }, { - "description": "burst requests read rate of the disk offering", + "description": "an optional field, whether to display the offering to the end user or not.", "length": 255, - "name": "iopsreadratemax", + "name": "displayoffering", "required": false, - "since": "4.15", - "type": "long" + "type": "boolean" }, { - "description": "io requests write rate of the disk offering", + "description": "burst bytes read rate of the disk offering", "length": 255, - "name": "iopswriterate", + "name": "bytesreadratemax", "required": false, "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", + "required": false, + "since": "4.13", + "type": "string" } ], "related": "createDiskOffering,listDiskOfferings", "response": [ { - "description": "the max iops of the disk offering", - "name": "maxiops", + "description": "the name of the disk offering", + "name": "name", + "type": "string" + }, + { + "description": "bytes write rate of the disk offering", + "name": "diskBytesWriteRate", "type": "long" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "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": "io requests read rate of the disk offering", + "name": "diskIopsReadRate", + "type": "long" + }, + { + "description": "io requests write rate of the disk offering", + "name": "diskIopsWriteRate", + "type": "long" }, { "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", @@ -16186,19 +16239,35 @@ "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 vsphere storage policy tagged to the disk offering in case of VMware", + "name": "vspherestoragepolicy", "type": "string" }, { - "description": "burst bytes read rate of the disk offering", - "name": "diskBytesReadRateMax", + "description": "an alternate display text of the disk offering.", + "name": "displaytext", + "type": "string" + }, + { + "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", + "name": "provisioningtype", + "type": "string" + }, + {}, + { + "description": "bytes read rate of the disk offering", + "name": "diskBytesReadRate", "type": "long" }, { - "description": "whether to display the offering to the end user or not.", - "name": "displayoffering", - "type": "boolean" + "description": "burst bytes write rate of the disk offering", + "name": "diskBytesWriteRateMax", + "type": "long" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { "description": "the size of the disk offering in GB", @@ -16211,14 +16280,14 @@ "type": "boolean" }, { - "description": "burst bytes write rate of the disk offering", - "name": "diskBytesWriteRateMax", - "type": "long" + "description": "true if disk offering uses custom iops, false otherwise", + "name": "iscustomizediops", + "type": "boolean" }, { - "description": "burst io requests write rate of the disk offering", - "name": "diskIopsWriteRateMax", - "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": "Whether disks using this offering will be encrypted on primary storage", @@ -16226,30 +16295,18 @@ "type": "boolean" }, { - "description": "an alternate display text of the disk offering.", - "name": "displaytext", - "type": "string" - }, - {}, - { - "description": "the tags for the disk offering", - "name": "tags", - "type": "string" - }, - {}, - { - "description": "unique ID of the disk offering", - "name": "id", - "type": "string" + "description": "additional key/value details tied with this disk offering", + "name": "details", + "type": "map" }, { - "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", - "name": "provisioningtype", - "type": "string" + "description": "length (in second) of the burst", + "name": "diskIopsReadRateMaxLength", + "type": "long" }, { - "description": "io requests write rate of the disk offering", - "name": "diskIopsWriteRate", + "description": "the min iops of the disk offering", + "name": "miniops", "type": "long" }, { @@ -16258,63 +16315,54 @@ "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 cache mode to use for this disk offering. none, writeback or writethrough", + "name": "cacheMode", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "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": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", "name": "domainid", "type": "string" }, + {}, { - "description": "state of the disk offering", - "name": "state", + "description": "the storage type for this disk offering", + "name": "storagetype", "type": "string" }, { - "description": "the min iops of the disk offering", - "name": "miniops", + "description": "length (in seconds) of the burst", + "name": "diskIopsWriteRateMaxLength", "type": "long" }, { - "description": "length (in second) of the burst", - "name": "diskIopsReadRateMaxLength", + "description": "the max iops of the disk offering", + "name": "maxiops", "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the storage type for this disk offering", - "name": "storagetype", - "type": "string" - }, - { - "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zone", - "type": "string" + "description": "burst io requests read rate of the disk offering", + "name": "diskIopsReadRateMax", + "type": "long" }, { - "description": "the name of the disk offering", - "name": "name", - "type": "string" + "description": "true if disk offering uses custom size, false otherwise", + "name": "iscustomized", + "type": "boolean" }, { - "description": "true if disk offering uses custom iops, false otherwise", - "name": "iscustomizediops", - "type": "boolean" + "description": "burst bytes read rate of the disk offering", + "name": "diskBytesReadRateMax", + "type": "long" }, { - "description": "length (in seconds) of the burst", - "name": "diskIopsWriteRateMaxLength", + "description": "burst io requests write rate of the disk offering", + "name": "diskIopsWriteRateMax", "type": "long" }, { @@ -16323,9 +16371,9 @@ "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": "state of the disk offering", + "name": "state", + "type": "string" }, { "description": "the date this disk offering was created", @@ -16333,44 +16381,34 @@ "type": "date" }, { - "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 vsphere storage policy tagged to the disk offering in case of VMware", - "name": "vspherestoragepolicy", + "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domain", "type": "string" }, { - "description": "additional key/value details tied with this disk offering", - "name": "details", - "type": "map" - }, - { - "description": "bytes read rate of the disk offering", - "name": "diskBytesReadRate", - "type": "long" + "description": "whether to display the offering to the end user or not.", + "name": "displayoffering", + "type": "boolean" }, { - "description": "the cache mode to use for this disk offering. none, writeback or writethrough", - "name": "cacheMode", + "description": "unique ID of the disk offering", + "name": "id", "type": "string" }, { - "description": "true if disk offering uses custom size, false otherwise", - "name": "iscustomized", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "bytes write rate of the disk offering", - "name": "diskBytesWriteRate", - "type": "long" - }, - { - "description": "burst io requests read rate of the disk offering", - "name": "diskIopsReadRateMax", - "type": "long" + "description": "the tags for the disk offering", + "name": "tags", + "type": "string" } ] }, @@ -16380,25 +16418,24 @@ "name": "removeVirtualMachinesFromKubernetesCluster", "params": [ { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "the ID of the Kubernetes cluster", + "description": "", "length": 255, - "name": "id", - "related": "createKubernetesCluster,startKubernetesCluster,listKubernetesClusters,scaleKubernetesCluster,upgradeKubernetesCluster", - "required": true, - "type": "uuid" + "name": "page", + "required": false, + "type": "integer" }, { "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,createVMFromBackup,createVMFromBackup,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", "required": true, "type": "list" }, @@ -16410,15 +16447,27 @@ "type": "integer" }, { - "description": "List by keyword", + "description": "the ID of the Kubernetes cluster", "length": 255, - "name": "keyword", - "required": false, - "type": "string" + "name": "id", + "related": "createKubernetesCluster,startKubernetesCluster,listKubernetesClusters,scaleKubernetesCluster,upgradeKubernetesCluster", + "required": true, + "type": "uuid" } ], "related": "", "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 id of the Kubernetes cluster", "name": "id", @@ -16434,17 +16483,6 @@ "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.19.0" @@ -16454,13 +16492,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 +16499,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": "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 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" } ] }, @@ -16501,19 +16539,19 @@ "name": "resetVpnConnection", "params": [ { - "description": "an optional domainId for connection. If the account parameter is used, domainId must also be used.", + "description": "an optional account for connection. Must be used with domainId.", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "an optional account for connection. Must be used with domainId.", + "description": "an optional domainId for connection. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "account", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", "required": false, - "type": "string" + "type": "uuid" }, { "description": "id of vpn connection", @@ -16527,70 +16565,83 @@ "related": "createVpnConnection,listVpnConnections,updateVpnConnection", "response": [ { - "description": "Lifetime of ESP SA of customer gateway", - "name": "esplifetime", - "type": "long" + "description": "the connection ID", + "name": "id", + "type": "string" }, - {}, { - "description": "public ip address id of the customer gateway", - "name": "gateway", + "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": "Lifetime of IKE SA of customer gateway", - "name": "ikelifetime", - "type": "long" + "description": "the domain id of the owner", + "name": "domainid", + "type": "string" }, { - "description": "the connection ID", - "name": "id", + "description": "the domain name of the owner", + "name": "domain", "type": "string" }, { - "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "if DPD is enabled for customer gateway", + "name": "dpd", + "type": "boolean" + }, + { + "description": "the project name", + "name": "project", "type": "string" }, { - "description": "IKE policy of the customer gateway", - "name": "ikepolicy", + "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { - "description": "the customer gateway ID", - "name": "s2scustomergatewayid", + "description": "the owner", + "name": "account", "type": "string" }, { - "description": "if Force NAT Encapsulation is enabled for customer gateway", - "name": "forceencap", + "description": "State of vpn connection", + "name": "passive", "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project id", + "name": "projectid", "type": "string" }, { - "description": "State of vpn connection", - "name": "state", - "type": "string" + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" }, { - "description": "ESP policy of the customer gateway", - "name": "esppolicy", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "the project name", - "name": "project", + "description": "Lifetime of ESP SA of customer gateway", + "name": "esplifetime", + "type": "long" + }, + { + "description": "the customer gateway ID", + "name": "s2scustomergatewayid", "type": "string" }, { - "description": "IPsec Preshared-Key of the customer gateway", - "name": "ipsecpsk", + "description": "IKE policy of the customer gateway", + "name": "ikepolicy", "type": "string" }, { @@ -16599,73 +16650,60 @@ "type": "boolean" }, { - "description": "if DPD is enabled for customer gateway", - "name": "dpd", - "type": "boolean" + "description": "ESP policy of the customer gateway", + "name": "esppolicy", + "type": "string" }, { - "description": "the domain id of the owner", - "name": "domainid", + "description": "public ip address id of the customer gateway", + "name": "gateway", "type": "string" }, { - "description": "State of vpn connection", - "name": "passive", + "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 name of the owner", - "name": "domain", - "type": "string" - }, - { - "description": "the vpn gateway ID", - "name": "s2svpngatewayid", + "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 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 owner", - "name": "account", - "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", + "description": "the domain path of the owner", + "name": "domainpath", "type": "string" }, { - "description": "the project id", - "name": "projectid", - "type": "string" + "description": "Lifetime of IKE SA of customer gateway", + "name": "ikelifetime", + "type": "long" }, + {}, { "description": "the public IP address", "name": "publicip", "type": "string" }, { - "description": "Split multiple remote networks into multiple phase 2 SAs. Often used with Cisco some products.", - "name": "splitconnections", - "type": "boolean" - }, - { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "State of vpn connection", + "name": "state", + "type": "string" }, + {}, { - "description": "the domain path of the owner", - "name": "domainpath", + "description": "the vpn gateway ID", + "name": "s2svpngatewayid", "type": "string" } ] @@ -16676,34 +16714,33 @@ "name": "listKubernetesClusters", "params": [ { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "name of the Kubernetes cluster (a substring match is made against the parameter value, data for all matching Kubernetes clusters will be returned)", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "name", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "", + "description": "state of the Kubernetes cluster", "length": 255, - "name": "pagesize", + "name": "state", "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", @@ -16712,13 +16749,6 @@ "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": "the ID of the Kubernetes cluster", "length": 255, @@ -16728,68 +16758,91 @@ "type": "uuid" }, { - "description": "", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "page", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "listall", + "name": "isrecursive", "required": false, "type": "boolean" }, { - "description": "list only resources belonging to the domain specified", + "description": "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": "state of the Kubernetes cluster", + "description": "", "length": 255, - "name": "state", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "name of the Kubernetes cluster (a substring match is made against the parameter value, data for all matching Kubernetes clusters will be returned)", + "description": "type of the cluster: CloudManaged, ExternalManaged", "length": 255, - "name": "name", + "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": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the name of the Kubernetes cluster", + "name": "name", "type": "string" }, { - "description": "the project name of the Kubernetes cluster", - "name": "project", + "description": "keypair details", + "name": "keypair", "type": "string" }, { - "description": "the ID of the template of the Kubernetes cluster", - "name": "templateid", + "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 UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "Minimum size of the cluster", - "name": "minsize", - "type": "long" + "description": "the description of the Kubernetes cluster", + "name": "description", + "type": "string" + }, + { + "description": "the ID of the domain in which the Kubernetes cluster exists", + "name": "domainid", + "type": "string" + }, + { + "description": "the ID of the template of the Kubernetes cluster", + "name": "templateid", + "type": "string" }, { "description": "the list of virtualmachine associated with this Kubernetes cluster", @@ -16797,59 +16850,70 @@ "type": "list" }, { - "description": "the control nodes count for the Kubernetes cluster", - "name": "controlnodes", - "type": "long" + "description": "the state of the Kubernetes cluster", + "name": "state", + "type": "string" }, { - "description": "the name of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionname", + "description": "the ID of the service offering of the worker nodes on the Kubernetes cluster", + "name": "workerofferingid", "type": "string" }, { - "description": "the project id of the Kubernetes cluster", - "name": "projectid", + "description": "path of the domain to which the Kubernetes cluster belongs", + "name": "domainpath", "type": "string" }, + {}, { "description": "the ID of the Kubernetes version for the Kubernetes cluster", "name": "kubernetesversionid", "type": "string" }, + { + "description": "the number of the etcd nodes on the Kubernetes cluster", + "name": "etcdnodes", + "type": "long" + }, + { + "description": "the size (worker nodes count) of the Kubernetes cluster", + "name": "size", + "type": "long" + }, { "description": "the name of the service offering of the Kubernetes cluster", "name": "serviceofferingname", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the service offering of the control nodes on the Kubernetes cluster", + "name": "controlofferingid", "type": "string" }, { - "description": "the date when this Kubernetes cluster was created", - "name": "created", - "type": "date" + "description": "the memory the Kubernetes cluster", + "name": "memory", + "type": "string" }, { - "description": "URL end point for the Kubernetes cluster", - "name": "endpoint", + "description": "Public IP Address of the cluster", + "name": "ipaddress", "type": "string" }, { - "description": "the name of the Kubernetes cluster", - "name": "name", + "description": "Public IP Address ID of the cluster", + "name": "ipaddressid", "type": "string" }, { - "description": "the name of the service offering of the etcd nodes on the Kubernetes cluster", - "name": "etcdofferingname", + "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": "the name of the zone of the Kubernetes cluster", + "name": "zonename", + "type": "string" }, { "description": "the ID of the service offering of the Kubernetes cluster", @@ -16857,28 +16921,23 @@ "type": "string" }, { - "description": "keypair details", - "name": "keypair", - "type": "string" + "description": "Maximum size of the cluster", + "name": "maxsize", + "type": "long" }, { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zonename", + "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": "Public IP Address of the cluster", - "name": "ipaddress", - "type": "string" + "description": "the date when this Kubernetes cluster was created", + "name": "created", + "type": "date" }, { - "description": "the name of the domain in which the Kubernetes cluster exists", - "name": "domain", + "description": "the cpu cores of the Kubernetes cluster", + "name": "cpunumber", "type": "string" }, { @@ -16886,127 +16945,111 @@ "name": "account", "type": "string" }, - {}, { - "description": "the name of the network of the Kubernetes cluster", - "name": "associatednetworkname", - "type": "string" + "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": "the id of the Kubernetes cluster", + "name": "id", "type": "string" }, { - "description": "the ID of the service offering of the worker nodes on the Kubernetes cluster", - "name": "workerofferingid", - "type": "string" + "description": "Whether autoscaling is enabled for the cluster", + "name": "autoscalingenabled", + "type": "boolean" }, { - "description": "the name of the service offering of the worker nodes on the Kubernetes cluster", - "name": "workerofferingname", - "type": "string" + "description": "Minimum size of the cluster", + "name": "minsize", + "type": "long" }, - {}, { "description": "the ID of the service offering of the etcd nodes on the Kubernetes cluster", "name": "etcdofferingid", "type": "string" }, { - "description": "the description of the Kubernetes cluster", - "name": "description", + "description": "the name of the domain in which the Kubernetes cluster exists", + "name": "domain", "type": "string" }, { - "description": "the ID of the service offering of the control nodes on the Kubernetes cluster", - "name": "controlofferingid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "ID of CNI Configuration associated with the cluster", - "name": "cniconfigurationid", + "description": "URL end point for the Kubernetes cluster dashboard UI", + "name": "consoleendpoint", "type": "string" }, { - "description": "Name of CNI Configuration associated with the cluster", - "name": "cniconfigname", + "description": "the name of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionname", "type": "string" }, + {}, { - "description": "the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", - "name": "masternodes", - "type": "long" - }, - { - "description": "Maximum size of the cluster", - "name": "maxsize", - "type": "long" - }, - { - "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", + "description": "the ID of the network of the Kubernetes cluster", + "name": "networkid", "type": "string" }, { - "description": "Public IP Address ID of the cluster", - "name": "ipaddressid", + "description": "the name of the zone of the Kubernetes cluster", + "name": "zoneid", "type": "string" }, { - "description": "the ID of the domain in which the Kubernetes cluster exists", - "name": "domainid", + "description": "URL end point for the Kubernetes cluster", + "name": "endpoint", "type": "string" }, { - "description": "the id of the Kubernetes cluster", - "name": "id", - "type": "string" + "description": "the control nodes count for the Kubernetes cluster", + "name": "controlnodes", + "type": "long" }, { - "description": "the state of the Kubernetes cluster", - "name": "state", - "type": "string" + "description": "Public IP Addresses of the etcd nodes", + "name": "etcdips", + "type": "map" }, { - "description": "the size (worker nodes count) of the Kubernetes cluster", - "name": "size", + "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", + "description": "Name of CNI Configuration associated with the cluster", + "name": "cniconfigname", "type": "string" }, { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zoneid", + "description": "the project name of the Kubernetes cluster", + "name": "project", "type": "string" }, { - "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": "Whether autoscaling is enabled for the cluster", - "name": "autoscalingenabled", - "type": "boolean" + "description": "the name of the network of the Kubernetes cluster", + "name": "associatednetworkname", + "type": "string" }, { - "description": "the ID of the network of the Kubernetes cluster", - "name": "networkid", + "description": "the project id of the Kubernetes cluster", + "name": "projectid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the type of the cluster", + "name": "clustertype", + "type": "clustertype" } ] }, @@ -17015,14 +17058,6 @@ "isasync": true, "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", "length": 255, @@ -17032,10 +17067,10 @@ "type": "string" }, { - "description": "the frequency in which the performance counters to be collected", + "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": "interval", - "required": false, + "name": "minmembers", + "required": true, "type": "integer" }, { @@ -17046,6 +17081,13 @@ "required": true, "type": "uuid" }, + { + "description": "the frequency in which the performance counters to be collected", + "length": 255, + "name": "interval", + "required": false, + "type": "integer" + }, { "description": "list of scaleup autoscale policies", "length": 255, @@ -17055,11 +17097,12 @@ "type": "list" }, { - "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": "an optional field, whether to the display the group to the end user or not", "length": 255, - "name": "minmembers", - "required": true, - "type": "integer" + "name": "fordisplay", + "required": false, + "since": "4.4", + "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.", @@ -17069,12 +17112,12 @@ "type": "integer" }, { - "description": "an optional field, whether to the display the group to the end user or not", + "description": "the ID of the load balancer rule", "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" + "name": "lbruleid", + "related": "createRoutingFirewallRule,listRoutingFirewallRules,createIpv6FirewallRule,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules", + "required": true, + "type": "uuid" }, { "description": "list of scaledown autoscale policies", @@ -17088,34 +17131,34 @@ "related": "disableAutoScaleVmGroup,enableAutoScaleVmGroup,listAutoScaleVmGroups,updateAutoScaleVmGroup", "response": [ { - "description": "the public ip address", - "name": "publicip", + "description": "the project name of the vm group", + "name": "project", "type": "string" }, { - "description": "the public ip address id", - "name": "publicipid", - "type": "string" + "description": "list of scaleup autoscale policies", + "name": "scaleuppolicies", + "type": "list" }, { - "description": "the project id of the vm group", - "name": "projectid", + "description": "the name of the autoscale vm group ", + "name": "name", "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", + "type": "string" }, { - "description": "the domain name of the vm group", - "name": "domain", + "description": "the load balancer rule ID", + "name": "lbruleid", "type": "string" }, { - "description": "path of the domain to which the vm group belongs", - "name": "domainpath", - "type": "string" + "description": "the date when this vm group was created", + "name": "created", + "type": "date" }, { "description": "the id of the guest network the lb rule belongs to", @@ -17123,51 +17166,45 @@ "type": "string" }, { - "description": "list of scaledown autoscale policies", - "name": "scaledownpolicies", - "type": "list" - }, - {}, - { - "description": "the domain ID of the vm group", - "name": "domainid", + "description": "the private port", + "name": "privateport", "type": "string" }, - {}, { - "description": "the date when this vm group was created", - "name": "created", - "type": "date" + "description": "the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number.", + "name": "maxmembers", + "type": "int" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "path of the domain to which the vm group belongs", + "name": "domainpath", + "type": "string" }, { - "description": "the frequency at which the conditions have to be evaluated", - "name": "interval", - "type": "int" + "description": "the autoscale vm group ID", + "name": "id", + "type": "string" }, { - "description": "the load balancer rule ID", - "name": "lbruleid", + "description": "the project id of the vm group", + "name": "projectid", "type": "string" }, + {}, { - "description": "the private port", - "name": "privateport", + "description": "the name of the guest network the lb rule belongs to", + "name": "associatednetworkname", "type": "string" }, { - "description": "list of scaleup autoscale policies", - "name": "scaleuppolicies", - "type": "list" + "description": "the number of available virtual machines (in Running, Starting, Stopping or Migrating state) in the vmgroup", + "name": "availablevirtualmachinecount", + "type": "int" }, { - "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 lb provider of the guest network the lb rule belongs to", @@ -17175,24 +17212,20 @@ "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 account owning the vm group", - "name": "account", + "description": "the public ip address", + "name": "publicip", "type": "string" }, + {}, { - "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 minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number.", - "name": "minmembers", - "type": "int" + "description": "the domain ID of the vm group", + "name": "domainid", + "type": "string" }, { "description": "the autoscale profile that contains information about the vms in the vm group.", @@ -17200,8 +17233,8 @@ "type": "string" }, { - "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" }, { @@ -17209,314 +17242,324 @@ "name": "fordisplay", "type": "boolean" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the current state of the AutoScale Vm Group", "name": "state", "type": "string" }, { - "description": "the autoscale vm group ID", - "name": "id", + "description": "the domain name of the vm group", + "name": "domain", "type": "string" }, { - "description": "the project name of the vm group", - "name": "project", - "type": "string" + "description": "list of scaledown autoscale policies", + "name": "scaledownpolicies", + "type": "list" }, { - "description": "the name of the autoscale vm group ", - "name": "name", + "description": "the public ip address id", + "name": "publicipid", "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": "Change the BGP peers for a VPC.", + "description": "add a baremetal ping pxe server", "isasync": true, - "name": "changeBgpPeersForVpc", + "name": "addBaremetalPxePingServer", "params": [ { - "description": "UUID of the VPC which the Bgp Peers are associated to.", + "description": "PING storage server ip", "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "name": "pingstorageserverip", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "Ids of the Bgp Peer. If it is empty, all BGP peers will be unlinked.", + "description": "type of pxe device", "length": 255, - "name": "bgppeerids", - "related": "createBgpPeer,listBgpPeers,updateBgpPeer,dedicateBgpPeer,releaseBgpPeer,changeBgpPeersForVpc", - "required": false, - "type": "list" - } - ], - "related": "createBgpPeer,listBgpPeers,updateBgpPeer,dedicateBgpPeer,releaseBgpPeer", - "response": [ - { - "description": "AS number of bgp peer", - "name": "asnumber", - "type": "long" - }, - { - "description": "the domain name of the bgp peer", - "name": "domain", + "name": "pxeservertype", + "required": true, "type": "string" }, { - "description": "the project name of the bgp peer", - "name": "project", - "type": "string" + "description": "Pod Id", + "length": 255, + "name": "podid", + "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", + "required": false, + "type": "uuid" }, { - "description": "IPv6 address of bgp peer", - "name": "ip6address", + "description": "Tftp root directory of PXE server", + "length": 255, + "name": "tftpdir", + "required": true, "type": "string" }, { - "description": "the account of the bgp peer", - "name": "account", - "type": "string" + "description": "the Physical Network ID", + "length": 255, + "name": "physicalnetworkid", + "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", + "required": true, + "type": "uuid" }, - {}, { - "description": "id of zone to which the bgp peer belongs to.", - "name": "zoneid", + "description": "URL of the external pxe device", + "length": 255, + "name": "url", + "required": true, "type": "string" }, { - "description": "the project id of the bgp peer", - "name": "projectid", + "description": "Password of PING storage server", + "length": 255, + "name": "pingcifspassword", + "required": false, "type": "string" }, { - "description": "password of bgp peer", + "description": "Credentials to reach external pxe device", + "length": 255, "name": "password", + "required": true, "type": "string" }, { - "description": "name of zone to which the bgp peer belongs to.", - "name": "zonename", + "description": "Credentials to reach external pxe device", + "length": 255, + "name": "username", + "required": true, "type": "string" }, { - "description": "date when this bgp peer was created.", - "name": "created", - "type": "date" + "description": "Username of PING storage server", + "length": 255, + "name": "pingcifsusername", + "required": false, + "type": "string" }, { - "description": "additional key/value details of the bgp peer", - "name": "details", - "type": "map" - }, + "description": "Root directory on PING storage server", + "length": 255, + "name": "pingdir", + "required": true, + "type": "string" + } + ], + "related": "", + "response": [ {}, { - "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": "IPv4 address of bgp peer", - "name": "ipaddress", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the domain ID of the bgp peer", - "name": "domainid", + "description": "Root directory on PING storage server", + "name": "pingdir", "type": "string" }, { - "description": "id of the bgp peer", - "name": "id", + "description": "the physical network to which this external dhcp device belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Tftp root directory of PXE server", + "name": "tftpdir", "type": "string" - } - ], - "since": "4.20.0" - }, - { - "description": "Deletes a load balancer rule.", - "isasync": true, - "name": "deleteLoadBalancerRule", - "params": [ + }, { - "description": "the ID of the load balancer rule", - "length": 255, + "description": "device id of ", "name": "id", - "related": "createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,updateIpv6FirewallRule", - "required": true, - "type": "uuid" - } - ], - "response": [ - { - "description": "any text associated with the success or failure", - "name": "displaytext", "type": "string" }, - {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the current status of the latest 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 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": "url", + "name": "url", + "type": "string" } ] }, { - "description": "add a baremetal ping pxe server", + "description": "Change the BGP peers for a VPC.", "isasync": true, - "name": "addBaremetalPxePingServer", + "name": "changeBgpPeersForVpc", "params": [ { - "description": "Tftp root directory of PXE server", + "description": "UUID of the VPC which the Bgp Peers are associated to.", "length": 255, - "name": "tftpdir", + "name": "vpcid", + "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", "required": true, - "type": "string" + "type": "uuid" }, { - "description": "Username of PING storage server", + "description": "Ids of the Bgp Peer. If it is empty, all BGP peers will be unlinked.", "length": 255, - "name": "pingcifsusername", + "name": "bgppeerids", + "related": "createBgpPeer,listBgpPeers,updateBgpPeer,dedicateBgpPeer,releaseBgpPeer,changeBgpPeersForVpc", "required": false, - "type": "string" - }, + "type": "list" + } + ], + "related": "createBgpPeer,listBgpPeers,updateBgpPeer,dedicateBgpPeer,releaseBgpPeer", + "response": [ { - "description": "Root directory on PING storage server", - "length": 255, - "name": "pingdir", - "required": true, + "description": "the domain name of the bgp peer", + "name": "domain", "type": "string" }, { - "description": "Pod Id", - "length": 255, - "name": "podid", - "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", - "required": false, - "type": "uuid" + "description": "AS number of bgp peer", + "name": "asnumber", + "type": "long" }, { - "description": "the Physical Network ID", - "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", - "required": true, - "type": "uuid" + "description": "the project id of the bgp peer", + "name": "projectid", + "type": "string" }, { - "description": "URL of the external pxe device", - "length": 255, - "name": "url", - "required": true, + "description": "id of the bgp peer", + "name": "id", "type": "string" }, { - "description": "PING storage server ip", - "length": 255, - "name": "pingstorageserverip", - "required": true, + "description": "password of bgp peer", + "name": "password", "type": "string" }, { - "description": "type of pxe device", - "length": 255, - "name": "pxeservertype", - "required": true, - "type": "string" + "description": "date when this bgp peer was created.", + "name": "created", + "type": "date" }, { - "description": "Password of PING storage server", - "length": 255, - "name": "pingcifspassword", - "required": false, + "description": "the project name of the bgp peer", + "name": "project", "type": "string" }, { - "description": "Credentials to reach external pxe device", - "length": 255, - "name": "password", - "required": true, + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "Credentials to reach external pxe device", - "length": 255, - "name": "username", - "required": true, - "type": "string" - } - ], - "related": "", - "response": [ + "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", + "description": "id of zone to which the bgp peer belongs to.", + "name": "zoneid", "type": "string" }, { - "description": "name of the provider", - "name": "provider", + "description": "additional key/value details of the bgp peer", + "name": "details", + "type": "map" + }, + {}, + { + "description": "IPv6 address of bgp peer", + "name": "ip6address", "type": "string" }, { - "description": "PING storage server ip", - "name": "pingstorageserverip", + "description": "name of zone to which the bgp peer belongs to.", + "name": "zonename", "type": "string" }, { - "description": "the physical network to which this external dhcp device belongs to", - "name": "physicalnetworkid", + "description": "the account of the bgp peer", + "name": "account", "type": "string" }, { - "description": "url", - "name": "url", + "description": "IPv4 address of bgp peer", + "name": "ipaddress", "type": "string" }, + { + "description": "the domain ID of the bgp peer", + "name": "domainid", + "type": "string" + } + ], + "since": "4.20.0" + }, + { + "description": "Deletes a load balancer rule.", + "isasync": true, + "name": "deleteLoadBalancerRule", + "params": [ + { + "description": "the ID of the load balancer rule", + "length": 255, + "name": "id", + "related": "createRoutingFirewallRule,listRoutingFirewallRules,createIpv6FirewallRule,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules", + "required": true, + "type": "uuid" + } + ], + "response": [ { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, - { - "description": "device id of ", - "name": "id", - "type": "string" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "Tftp root directory of PXE server", - "name": "tftpdir", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {}, {} ] }, @@ -17526,11 +17569,11 @@ "name": "listPortableIpRanges", "params": [ { - "description": "List by keyword", + "description": "Id of a Region", "length": 255, - "name": "keyword", + "name": "regionid", "required": false, - "type": "string" + "type": "integer" }, { "description": "", @@ -17540,11 +17583,11 @@ "type": "integer" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { "description": "Id of the portable ip range", @@ -17555,9 +17598,9 @@ "type": "uuid" }, { - "description": "Id of a Region", + "description": "", "length": 255, - "name": "regionid", + "name": "pagesize", "required": false, "type": "integer" } @@ -17565,25 +17608,20 @@ "related": "createPortableIpRange", "response": [ { - "description": "the start ip of the portable IP range", - "name": "startip", - "type": "string" - }, - {}, - { - "description": "portable IP range ID", - "name": "id", + "description": "the end ip of the portable IP range", + "name": "endip", "type": "string" }, { - "description": "Region Id in which portable ip range is provisioned", - "name": "regionid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, {}, + {}, { - "description": "the end ip of the portable IP range", - "name": "endip", + "description": "the start ip of the portable IP range", + "name": "startip", "type": "string" }, { @@ -17592,27 +17630,37 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "portable IP range ID", + "name": "id", + "type": "string" + }, + { + "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 netmask of the VLAN IP range", "name": "netmask", "type": "string" }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "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", - "type": "string" - }, - { - "description": "the account ID the portable IP address is associated with", - "name": "accountid", + "description": "the ID of the zone the public IP address belongs to", + "name": "zoneid", "type": "string" }, { @@ -17621,23 +17669,18 @@ "type": "string" }, { - "description": "the ID of the Network where ip belongs to", - "name": "networkid", + "description": "State of the ip address. Can be: Allocating, Allocated, Releasing and Free", + "name": "state", "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", + "description": "VPC the ip belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the ID of the zone the public IP address belongs to", - "name": "zoneid", + "description": "the account ID the portable IP address is associated with", + "name": "accountid", "type": "string" }, { @@ -17645,28 +17688,28 @@ "name": "ipaddress", "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": "VPC the ip belongs to", - "name": "vpcid", + "description": "date the portal IP address was acquired", + "name": "allocated", + "type": "date" + }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" } ], "type": "list" - }, - { - "description": "the gateway of the VLAN IP range", - "name": "gateway", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" } ] }, @@ -17679,27 +17722,21 @@ "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,createVMFromBackup,createVMFromBackup,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", "required": true, "type": "uuid" } ], "related": "", "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "Base64 encoded VM user data", "name": "userdata", "type": "string" }, - {}, { - "description": "the ID of the virtual machine", - "name": "virtualmachineid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -17707,6 +17744,12 @@ "name": "jobstatus", "type": "integer" }, + { + "description": "the ID of the virtual machine", + "name": "virtualmachineid", + "type": "string" + }, + {}, {} ], "since": "4.4" @@ -17717,18 +17760,18 @@ "name": "createNetworkPermissions", "params": [ { - "description": "a comma delimited list of projects within owner's domain. If specified, \"op\" parameter has to be passed in.", + "description": "a comma delimited list of account IDs within owner's domain. If specified, \"op\" parameter has to be passed in.", "length": 255, - "name": "projectids", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "accountids", + "related": "createAccount,disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", "required": false, "type": "list" }, { - "description": "a comma delimited list of account IDs within owner's domain. If specified, \"op\" parameter has to be passed in.", + "description": "a comma delimited list of projects within owner's domain. If specified, \"op\" parameter has to be passed in.", "length": 255, - "name": "accountids", - "related": "createAccount,disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", + "name": "projectids", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, "type": "list" }, @@ -17754,23 +17797,23 @@ "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": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + } ], "since": "4.17.0" }, @@ -17789,6 +17832,11 @@ } ], "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "true if operation is executed successfully", "name": "success", @@ -17800,17 +17848,12 @@ "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" - }, - {} + } ] }, { @@ -17818,6 +17861,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,30 +17875,19 @@ "related": "listNics", "required": true, "type": "uuid" - }, - { - "description": "Secondary IP Address", - "length": 255, - "name": "ipaddress", - "required": false, - "type": "string" } ], "related": "", "response": [ { - "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", + "description": "the ID of the nic", + "name": "nicid", "type": "string" }, + {}, { - "description": "the ID of the secondary private IP addr", - "name": "id", + "description": "the ID of the vm", + "name": "virtualmachineid", "type": "string" }, { @@ -17856,26 +17895,30 @@ "name": "jobstatus", "type": "integer" }, + { + "description": "the list of Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, { "description": "the ID of the network", "name": "networkid", "type": "string" }, - {}, { - "description": "the ID of the nic", - "name": "nicid", + "description": "Secondary IP address", + "name": "ipaddress", "type": "string" }, { - "description": "Secondary IP address", - "name": "ipaddress", + "description": "the ID of the secondary private IP addr", + "name": "id", "type": "string" }, {}, { - "description": "the ID of the vm", - "name": "virtualmachineid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ] @@ -17886,11 +17929,27 @@ "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.", + "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" + }, + { + "description": "DEPRECATED. Integer value for the usage type of the resource", "length": 255, - "name": "startdate", + "name": "usagetype", + "required": false, + "type": "integer" + }, + { + "description": "Quota tariff's description. Inform empty to remove the description.", + "length": 65535, + "name": "description", "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.", @@ -17908,21 +17967,6 @@ "since": "4.20.0.0", "type": "integer" }, - { - "description": "DEPRECATED. Integer value for the usage type of the resource", - "length": 255, - "name": "usagetype", - "required": false, - "type": "integer" - }, - { - "description": "Quota tariff's description. Inform empty to remove the description.", - "length": 65535, - "name": "description", - "required": false, - "since": "4.18.0.0", - "type": "string" - }, { "description": "Quota tariff's name", "length": 65535, @@ -17939,30 +17983,28 @@ "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", + "description": "DEPRECATED. The effective start date on/after which the quota tariff is effective. Use yyyy-MM-dd as the date format, e.g. startDate=2009-06-03.", + "length": 255, + "name": "startdate", "required": false, - "since": "4.18.0.0", - "type": "string" + "type": "date" } ], "related": "quotaTariffList,quotaTariffCreate", "response": [ - {}, { - "description": "tariffValue", - "name": "tariffValue", - "type": "bigdecimal" + "description": "usageDiscriminator", + "name": "usageDiscriminator", + "type": "string" }, { - "description": "usageName", - "name": "usageName", - "type": "string" + "description": "the start date of the quota tariff", + "name": "effectiveDate", + "type": "date" }, { - "description": "activation rule of the quota tariff", - "name": "activationRule", + "description": "description", + "name": "description", "type": "string" }, {}, @@ -17972,34 +18014,40 @@ "type": "string" }, { - "description": "the end date of the quota tariff", - "name": "endDate", - "type": "date" + "description": "currency", + "name": "currency", + "type": "string" }, + {}, { - "description": "description", - "name": "description", - "type": "string" + "description": "usageType", + "name": "usageType", + "type": "int" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "tariffValue", + "name": "tariffValue", + "type": "bigdecimal" + }, + { + "description": "name", + "name": "name", "type": "string" }, { - "description": "usageDiscriminator", - "name": "usageDiscriminator", + "description": "activation rule of the quota tariff", + "name": "activationRule", "type": "string" }, { - "description": "currency", - "name": "currency", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the start date of the quota tariff", - "name": "effectiveDate", - "type": "date" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the ID of the tariff", @@ -18007,8 +18055,13 @@ "type": "string" }, { - "description": "name", - "name": "name", + "description": "the end date of the quota tariff", + "name": "endDate", + "type": "date" + }, + { + "description": "usageUnit", + "name": "usageUnit", "type": "string" }, { @@ -18017,23 +18070,13 @@ "type": "date" }, { - "description": "position in the execution sequence for tariffs of the same type", - "name": "position", - "type": "integer" - }, - { - "description": "usageUnit", - "name": "usageUnit", + "description": "usageName", + "name": "usageName", "type": "string" }, { - "description": "usageType", - "name": "usageType", - "type": "int" - }, - { - "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" } ], @@ -18054,28 +18097,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": "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" - } + {}, + {} ] }, { @@ -18083,11 +18126,18 @@ "isasync": false, "name": "deleteHost", "params": [ + { + "description": "Force delete the host. All HA enabled vms running on the host will be put to HA; HA disabled ones will be stopped", + "length": 255, + "name": "forced", + "required": false, + "type": "boolean" + }, { "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" }, @@ -18097,21 +18147,9 @@ "name": "forcedestroylocalstorage", "required": false, "type": "boolean" - }, - { - "description": "Force delete the host. All HA enabled vms running on the host will be put to HA; HA disabled ones will be stopped", - "length": 255, - "name": "forced", - "required": false, - "type": "boolean" } ], "response": [ - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, { "description": "true if operation is executed successfully", "name": "success", @@ -18119,6 +18157,11 @@ }, {}, {}, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -18137,33 +18180,21 @@ "name": "deleteResourceIcon", "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" } ], "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", @@ -18173,6 +18204,18 @@ "description": "the UUID of the latest async 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.16.0.0" @@ -18185,48 +18228,38 @@ "related": "", "response": [ { - "description": "true if Kubernetes Service plugin is enabled, false otherwise", - "name": "kubernetesserviceenabled", - "type": "boolean" - }, - { - "description": "true if snapshot is supported for KVM host, false otherwise", - "name": "kvmsnapshotenabled", - "type": "boolean" - }, - { - "description": "time interval (in seconds) to reset api count", - "name": "apilimitinterval", + "description": "the retention time for Instances stats", + "name": "instancesstatsretentiontime", "type": "integer" }, { - "description": "true if the user can recover and expunge volumes, false otherwise", - "name": "allowuserexpungerecovervolume", + "description": "true if instance lease feature is enabled", + "name": "instanceleaseenabled", "type": "boolean" }, { - "description": "true if dynamically scaling for instances is enabled", - "name": "dynamicscalingenabled", - "type": "boolean" + "description": "The path of the extensions directory", + "name": "extensionspath", + "type": "string" }, { - "description": "true if users are allowed to force stop a vm, false otherwise", - "name": "allowuserforcestopvm", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "If invitation confirmation is required when add account to project", - "name": "projectinviterequired", - "type": "boolean" + "description": "time interval (in seconds) to reset api count", + "name": "apilimitinterval", + "type": "integer" }, { - "description": "true if dynamic role-based api checker is enabled, false otherwise", - "name": "dynamicrolesenabled", + "description": "true if the user can recover and expunge virtualmachines, false otherwise", + "name": "allowuserexpungerecovervm", "type": "boolean" }, { - "description": "true if the user is allowed to view destroyed virtualmachines, false otherwise", - "name": "allowuserviewdestroyedvm", + "description": "true if user and domain admins can set templates to be shared, false otherwise", + "name": "userpublictemplateenabled", "type": "boolean" }, { @@ -18234,15 +18267,16 @@ "name": "jobstatus", "type": "integer" }, + {}, { - "description": "true if stats are retained for instance disks otherwise false", - "name": "instancesdisksstatsretentionenabled", + "description": "true if users are allowed to force stop a vm, false otherwise", + "name": "allowuserforcestopvm", "type": "boolean" }, { - "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": "the min CPU count for the service offering used by the shared filesystem instance", @@ -18250,39 +18284,39 @@ "type": "integer" }, { - "description": "the min Ram size for the service offering used by the shared filesystem instance", - "name": "sharedfsvmminramsize", - "type": "integer" + "description": "true if experimental features for Kubernetes cluster such as Docker private registry are enabled, false otherwise", + "name": "kubernetesclusterexperimentalfeaturesenabled", + "type": "boolean" }, { - "description": "true if security groups support is enabled, false otherwise", - "name": "securitygroupsenabled", - "type": "boolean" + "description": "minimum size that can be specified when create disk from disk offering with custom size", + "name": "customdiskofferingminsize", + "type": "long" }, { - "description": "true if region supports elastic load balancer on basic zones", - "name": "supportELB", - "type": "string" + "description": "true if Kubernetes Service plugin is enabled, false otherwise", + "name": "kubernetesserviceenabled", + "type": "boolean" }, { - "description": "true if users can see all accounts within the same domain, false otherwise", - "name": "allowuserviewalldomainaccounts", + "description": "If invitation confirmation is required when add account to project", + "name": "projectinviterequired", "type": "boolean" }, { - "description": "minimum size that can be specified when create disk from disk offering with custom size", - "name": "customdiskofferingminsize", - "type": "long" + "description": "true if region wide secondary is enabled, false otherwise", + "name": "regionsecondaryenabled", + "type": "boolean" }, { - "description": "the retention time for Instances disks stats", - "name": "instancesdisksstatsretentiontime", + "description": "Max allowed number of api requests within the specified interval", + "name": "apilimitmax", "type": "integer" }, { - "description": "the retention time for Instances stats", - "name": "instancesstatsretentiontime", - "type": "integer" + "description": "true if users can see all accounts within the same domain, false otherwise", + "name": "allowuserviewalldomainaccounts", + "type": "boolean" }, { "description": "true if regular user is allowed to create projects", @@ -18295,60 +18329,74 @@ "type": "long" }, { - "description": "true if the user can recover and expunge virtualmachines, false otherwise", - "name": "allowuserexpungerecovervm", - "type": "boolean" - }, - { - "description": "Max allowed number of api requests within the specified interval", - "name": "apilimitmax", + "description": "the min Ram size for the service offering used by the shared filesystem instance", + "name": "sharedfsvmminramsize", "type": "integer" }, { - "description": "true if experimental features for Kubernetes cluster such as Docker private registry are enabled, false otherwise", - "name": "kubernetesclusterexperimentalfeaturesenabled", + "description": "true if stats are collected only for user instances, false if system instance stats are also collected", + "name": "instancesstatsuseronly", "type": "boolean" }, { - "description": "Display name for custom hypervisor", - "name": "customhypervisordisplayname", - "type": "string" + "description": "true if the user can recover and expunge volumes, false otherwise", + "name": "allowuserexpungerecovervolume", + "type": "boolean" }, { "description": "default page size in the UI for various views, value set in the configurations", "name": "defaultuipagesize", "type": "long" }, + {}, { - "description": "The path of the extensions directory", - "name": "extensionspath", - "type": "string" + "description": "true if dynamic role-based api checker is enabled, false otherwise", + "name": "dynamicrolesenabled", + "type": "boolean" }, - {}, { - "description": "version of the cloud stack", - "name": "cloudstackversion", - "type": "string" + "description": "true if snapshot is supported for KVM host, false otherwise", + "name": "kvmsnapshotenabled", + "type": "boolean" }, { - "description": "true if instance lease feature is enabled", - "name": "instanceleaseenabled", + "description": "true if additional configurations or extraconfig can be passed to Instances", + "name": "additionalconfigenabled", "type": "boolean" }, { - "description": "true if user and domain admins can set templates to be shared, false otherwise", - "name": "userpublictemplateenabled", + "description": "true if the user is allowed to view destroyed virtualmachines, false otherwise", + "name": "allowuserviewdestroyedvm", "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", + "description": "Display name for custom hypervisor", + "name": "customhypervisordisplayname", + "type": "string" + }, + { + "description": "true if stats are retained for instance disks otherwise false", + "name": "instancesdisksstatsretentionenabled", + "type": "boolean" + }, + { + "description": "the retention time for Instances disks stats", + "name": "instancesdisksstatsretentiontime", + "type": "integer" + }, + { + "description": "true if dynamically scaling for instances is enabled", + "name": "dynamicscalingenabled", + "type": "boolean" + }, + { + "description": "true if region supports elastic load balancer on basic zones", + "name": "supportELB", "type": "string" } ] @@ -18368,18 +18416,12 @@ } ], "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", @@ -18389,6 +18431,12 @@ "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" } ] }, @@ -18401,7 +18449,7 @@ "description": "network service provider id", "length": 255, "name": "id", - "related": "addNetworkServiceProvider,listNetworkServiceProviders,updateNetworkServiceProvider,listTrafficTypes", + "related": "addNetworkServiceProvider,listNetworkServiceProviders,updateNetworkServiceProvider", "required": true, "type": "uuid" }, @@ -18420,22 +18468,32 @@ "type": "list" } ], - "related": "addNetworkServiceProvider,listNetworkServiceProviders,listTrafficTypes", + "related": "addNetworkServiceProvider,listNetworkServiceProviders", "response": [ { "description": "the provider name", "name": "name", "type": "string" }, + { + "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": "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": "state of the network provider", + "name": "state", + "type": "string" }, { "description": "services for this provider", @@ -18443,32 +18501,22 @@ "type": "list" }, { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "state of the network provider", - "name": "state", + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", "type": "string" }, - { - "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" }, @@ -18477,47 +18525,32 @@ "isasync": true, "name": "checkVolume", "params": [ - { - "description": "The ID of the volume", - "length": 255, - "name": "id", - "related": "attachVolume,checkVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", - "required": true, - "type": "uuid" - }, { "description": "parameter to repair the volume, leaks or all are the possible values", "length": 255, "name": "repair", "required": false, "type": "string" + }, + { + "description": "The ID of the volume", + "length": 255, + "name": "id", + "related": "importVolume,attachVolume,checkVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", + "required": true, + "type": "uuid" } ], - "related": "attachVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", + "related": "importVolume,attachVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", "response": [ { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "the status of the volume", - "name": "status", - "type": "string" - }, - { - "description": "details for the volume check result, they may vary for different hypervisors", - "name": "volumecheckresult", - "type": "map" - }, - { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", - "type": "string" + "description": "min iops of the disk volume", + "name": "miniops", + "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" }, { @@ -18526,28 +18559,23 @@ "type": "long" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "cluster id of the volume", + "name": "clusterid", "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", + "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 display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", + "type": "string" }, { - "description": "the format of the disk encryption if applicable", - "name": "encryptformat", + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", "type": "string" }, { @@ -18556,29 +18584,39 @@ "type": "integer" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", "type": "long" }, { - "description": "the disk utilization", - "name": "utilization", + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", "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": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" + }, { "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 disk offering", + "name": "diskofferingname", + "type": "string" + }, + { + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, { "description": "path of the Domain the disk volume belongs to", @@ -18591,77 +18629,82 @@ "type": "long" }, { - "description": "the path of the volume", - "name": "path", + "description": "shared or local storage", + "name": "storagetype", "type": "string" }, { - "description": "the chain info of the volume", - "name": "chaininfo", - "type": "string" + "description": "the bytes allocated", + "name": "virtualsize", + "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 disk utilization", + "name": "utilization", "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 template for the virtual machine", - "name": "templatedisplaytext", + "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 account associated with the disk volume", + "name": "account", + "type": "string" }, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" + "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": "name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" }, { - "description": "the bytes allocated", - "name": "virtualsize", - "type": "long" + "description": "details for the volume check result, they may vary for different hypervisors", + "name": "volumecheckresult", + "type": "map" + }, + { + "description": "ID of the availability zone", + "name": "zoneid", + "type": "string" }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "the account associated with the tag", - "name": "account", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -18670,13 +18713,13 @@ "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 name where tag belongs to", - "name": "project", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -18690,188 +18733,188 @@ "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 id the tag belongs to", - "name": "projectid", + "description": "resource type", + "name": "resourcetype", "type": "string" } ], "type": "set" }, { - "description": "the account associated with the disk volume", - "name": "account", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": "the state of the disk volume", - "name": "state", + "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": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "min iops of the disk volume", - "name": "miniops", + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", "type": "long" }, { - "description": "true if volume has delete protection.", - "name": "deleteprotection", + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", "type": "boolean" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", - "type": "string" + "description": "the read (IO) of disk on the vm", + "name": "diskioread", + "type": "long" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "pod name of the volume", + "name": "podname", "type": "string" }, + {}, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", - "type": "string" + "description": "the 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": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", + "type": "string" }, { - "description": "max iops of the disk volume", - "name": "maxiops", - "type": "long" + "description": "the format of the disk encryption if applicable", + "name": "encryptformat", + "type": "string" }, { - "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 display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", - "type": "string" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, {}, - {}, { - "description": "name of the virtual machine", - "name": "vmname", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "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": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", - "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": "the project id of the vpn", + "name": "projectid", "type": "string" }, { - "description": "type of the virtual machine", - "name": "vmtype", + "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": "pod id of the volume", - "name": "podid", + "description": "the chain info of the volume", + "name": "chaininfo", "type": "string" }, { - "description": "name of the disk volume", - "name": "name", + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", + "description": "size of the disk volume", + "name": "size", "type": "long" }, { - "description": "ID of the availability zone", - "name": "zoneid", - "type": "string" + "description": "true if volume has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", "type": "string" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "type": "long" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "type of the virtual machine", + "name": "vmtype", "type": "string" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "id of the virtual machine", + "name": "virtualmachineid", "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": "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": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", + "type": "boolean" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", + "description": "the status of the volume", + "name": "status", "type": "string" }, { @@ -18880,43 +18923,48 @@ "type": "boolean" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", - "type": "string" + "description": "max iops of the disk volume", + "name": "maxiops", + "type": "long" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "the date the disk volume was created", + "name": "created", + "type": "date" + }, + { + "description": "name of the virtual machine", + "name": "vmname", "type": "string" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "pod id of the volume", + "name": "podid", "type": "string" }, { - "description": "details for the volume repair result, they may vary for different hypervisors", - "name": "volumerepairresult", - "type": "map" + "description": "ID of the disk volume", + "name": "id", + "type": "string" }, { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" }, { - "description": "ID of the disk volume", - "name": "id", + "description": "the path of the volume", + "name": "path", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "ID of the disk offering", + "name": "diskofferingid", + "type": "string" }, { - "description": "pod name of the volume", - "name": "podname", + "description": "cluster name where the volume is allocated", + "name": "clustername", "type": "string" } ], @@ -18927,6 +18975,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, @@ -18936,18 +18991,20 @@ "type": "boolean" }, { - "description": "List by keyword", + "description": "the id of the management server", "length": 255, - "name": "keyword", + "name": "id", + "related": "listManagementServers", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "", + "description": "Whether to return the management server peers or not. By default, the management server peers will not be returned.", "length": 255, - "name": "pagesize", + "name": "peers", "required": false, - "type": "integer" + "since": "4.20.1.0", + "type": "boolean" }, { "description": "", @@ -18957,192 +19014,168 @@ "type": "integer" }, { - "description": "the name of the management server", - "length": 255, - "name": "name", - "required": false, - "type": "string" - }, - { - "description": "the id of the management server", + "description": "", "length": 255, - "name": "id", - "related": "listManagementServers", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "Whether to return the management server peers or not. By default, the management server peers will not be returned.", + "description": "List by keyword", "length": 255, - "name": "peers", + "name": "keyword", "required": false, - "since": "4.20.1.0", - "type": "boolean" + "type": "string" } ], "related": "", "response": [ { - "description": "The number of blocked threads", - "name": "threadsblockedcount", - "type": "integer" - }, - { - "description": "The number of waiting threads", - "name": "threadswaitingcount", + "description": "The number of terminated threads", + "name": "threadsteminatedcount", "type": "integer" }, { - "description": "the number of host agents this Management Server is responsible for", - "name": "agentscount", - "type": "long" - }, - { - "description": "the IP Address for this Management Server. This is deprecated, please use 'ipaddress' instead.", - "name": "serviceip", + "description": "Amount of memory used", + "name": "systemmemoryused", "type": "string" }, - {}, { - "description": "Total system memory", - "name": "systemmemorytotal", - "type": "string" + "description": "the amount of memory used by this Management Server", + "name": "heapmemoryused", + "type": "long" }, { - "description": "the version of the java distribution running the management server process", - "name": "javaversion", - "type": "string" + "description": "the time these statistics were collected", + "name": "collectiontime", + "type": "date" }, { "description": "the number of pending jobs in this Management Server", "name": "pendingjobscount", "type": "long" }, - { - "description": "The number of runnable threads", - "name": "threadsrunnablecount", - "type": "integer" - }, { "description": "the system is running against a local database", "name": "dbislocal", "type": "boolean" }, + {}, { - "description": "The number of daemon threads", - "name": "threadsdaemoncount", - "type": "integer" + "description": "the name of the OS distribution running on the management server", + "name": "osdistribution", + "type": "string" }, { - "description": "The number of terminated threads", - "name": "threadsteminatedcount", - "type": "integer" + "description": "the last time this Management Server was started", + "name": "lastserverstart", + "type": "date" }, { - "description": "the name of the management server", - "name": "name", - "type": "string" + "description": "the last agents this Management Server is responsible for, before shutdown or preparing for maintenance", + "name": "lastagents", + "type": "list" }, { - "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": "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", - "name": "systemloadaverages", - "type": "double[]" + "description": "The number of waiting threads", + "name": "threadswaitingcount", + "type": "integer" }, { - "description": "the ID of the management server", - "name": "id", - "type": "string" + "description": "the system has a usage server running locally", + "name": "usageislocal", + "type": "boolean" }, { - "description": "the last time the host on which this Management Server runs was booted", - "name": "lastboottime", - "type": "date" + "description": "the load averages for 1 5 and 15 minutes", + "name": "systemloadaverages", + "type": "double[]" }, { - "description": "Free system memory", - "name": "systemmemoryfree", + "description": "the java distribution name running the management server process", + "name": "javadistribution", "type": "string" }, { - "description": "the log files and their usage on disk", - "name": "loginfo", + "description": "the IP Address for this Management Server", + "name": "ipaddress", "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 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": "Free system memory", + "name": "systemmemoryfree", + "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the running OS kernel version for this Management Server", + "name": "kernelversion", "type": "string" }, { - "description": "the version of the management server", - "name": "version", + "description": "The number of runnable threads", + "name": "threadsrunnablecount", + "type": "integer" + }, + { + "description": "the name of the management server", + "name": "name", "type": "string" }, { - "description": "the last time this Management Server was stopped", - "name": "lastserverstop", - "type": "date" + "description": "the Management Server Peers", + "name": "peers", + "type": "list" }, - {}, { - "description": "Amount of memory used", - "name": "systemmemoryused", + "description": "Total system memory", + "name": "systemmemorytotal", "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 IP Address for this Management Server", - "name": "ipaddress", + "description": "Virtual size of the fully loaded process", + "name": "systemmemoryvirtualsize", "type": "string" }, { - "description": "the state of the management server", - "name": "state", - "type": "state" + "description": "the total system cpu capacity", + "name": "systemtotalcpucycles", + "type": "double" }, { - "description": "the last time this Management Server was started", - "name": "lastserverstart", - "type": "date" + "description": "the version of the management server", + "name": "version", + "type": "string" }, { - "description": "the last agents this Management Server is responsible for, before shutdown or preparing for maintenance", - "name": "lastagents", - "type": "list" + "description": "the number of agents this Management Server is responsible for", + "name": "agentcount", + "type": "integer" }, { "description": "the agents this Management Server is responsible for", @@ -19150,34 +19183,39 @@ "type": "list" }, { - "description": "Virtual size of the fully loaded process", - "name": "systemmemoryvirtualsize", + "description": "The number of blocked threads", + "name": "threadsblockedcount", + "type": "integer" + }, + { + "description": "the ID of the management server", + "name": "id", "type": "string" }, { - "description": "the system has a usage server running locally", - "name": "usageislocal", - "type": "boolean" + "description": "the last time this Management Server was stopped", + "name": "lastserverstop", + "type": "date" }, { - "description": "the name of the OS distribution running on the management server", - "name": "osdistribution", + "description": "the log files and their usage on disk", + "name": "loginfo", "type": "string" }, { - "description": "the amount of memory used by this Management Server", - "name": "heapmemoryused", - "type": "long" + "description": "The number of threads", + "name": "threadstotalcount", + "type": "integer" }, { - "description": "the number of agents this Management Server is responsible for", - "name": "agentcount", - "type": "integer" + "description": "the version of the java distribution running the management server process", + "name": "javaversion", + "type": "string" }, { - "description": "the total system cpu capacity", - "name": "systemtotalcpucycles", - "type": "double" + "description": "The number of daemon threads", + "name": "threadsdaemoncount", + "type": "integer" }, { "description": "the current cpu load", @@ -19185,19 +19223,29 @@ "type": "string" }, { - "description": "the system load for user, and system processes and the system idle cycles", - "name": "systemcycleusage", - "type": "long[]" + "description": "the last time the host on which this Management Server runs was booted", + "name": "lastboottime", + "type": "date" }, { - "description": "the amount of memory allocated to this Management Server", - "name": "heapmemorytotal", - "type": "long" + "description": "the number of processors available to the JVM", + "name": "availableprocessors", + "type": "integer" }, { - "description": "The number of threads", - "name": "threadstotalcount", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the IP Address for this Management Server. This is deprecated, please use 'ipaddress' instead.", + "name": "serviceip", + "type": "string" + }, + { + "description": "the state of the management server", + "name": "state", + "type": "state" } ], "since": "4.17.0" @@ -19208,53 +19256,53 @@ "name": "removeFromLoadBalancerRule", "params": [ { - "description": "VM ID and IP map, vmidipmap[0].vmid=1 vmidipmap[0].ip=10.1.1.75", + "description": "The ID of the load balancer rule", "length": 255, - "name": "vmidipmap", - "required": false, - "since": "4.4", - "type": "map" + "name": "id", + "related": "createRoutingFirewallRule,listRoutingFirewallRules,createIpv6FirewallRule,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules", + "required": true, + "type": "uuid" }, { "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,createVMFromBackup,createVMFromBackup,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", "required": false, "type": "list" }, { - "description": "The ID of the load balancer rule", + "description": "VM ID and IP map, vmidipmap[0].vmid=1 vmidipmap[0].ip=10.1.1.75", "length": 255, - "name": "id", - "related": "createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,updateIpv6FirewallRule", - "required": true, - "type": "uuid" + "name": "vmidipmap", + "required": false, + "since": "4.4", + "type": "map" } ], "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" - }, - {} + } ] }, { @@ -19262,34 +19310,26 @@ "isasync": false, "name": "listInstanceGroups", "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": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "listall", + "name": "account", "required": false, - "type": "boolean" + "type": "string" }, { "description": "list only resources belonging to the domain specified", @@ -19300,26 +19340,25 @@ "type": "uuid" }, { - "description": "List by keyword", + "description": "list instance groups by name", "length": 255, - "name": "keyword", + "name": "name", "required": false, "type": "string" }, { - "description": "list instance groups by name", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "name", + "name": "listall", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "list instance groups by ID", + "description": "", "length": 255, - "name": "id", - "related": "createInstanceGroup,listInstanceGroups,updateInstanceGroup", + "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.", @@ -19329,50 +19368,59 @@ "type": "boolean" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "account", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, - "type": "string" + "type": "uuid" + }, + { + "description": "list instance groups by ID", + "length": 255, + "name": "id", + "related": "createInstanceGroup,listInstanceGroups,updateInstanceGroup", + "required": false, + "type": "uuid" } ], "related": "createInstanceGroup,updateInstanceGroup", "response": [ { - "description": "time and date the instance group was created", - "name": "created", - "type": "date" + "description": "the ID of the instance group", + "name": "id", + "type": "string" }, { - "description": "the account owning the instance group", - "name": "account", + "description": "the name of the instance group", + "name": "name", "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 instance group", "name": "domain", "type": "string" }, - {}, { "description": "the project name of the instance group", "name": "project", "type": "string" }, { - "description": "the domain ID of the instance group", - "name": "domainid", - "type": "string" + "description": "time and date the instance group was created", + "name": "created", + "type": "date" }, + {}, { - "description": "path of the Domain the instance group belongs to", - "name": "domainpath", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -19381,24 +19429,24 @@ "type": "string" }, { - "description": "the ID of the instance group", - "name": "id", + "description": "the domain ID of the instance group", + "name": "domainid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the name of the instance group", - "name": "name", + "description": "path of the Domain the instance group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the account owning the instance group", + "name": "account", + "type": "string" } ] }, @@ -19407,6 +19455,21 @@ "isasync": true, "name": "createStaticRoute", "params": [ + { + "description": "static route cidr", + "length": 255, + "name": "cidr", + "required": true, + "type": "string" + }, + { + "description": "the gateway id we are creating static route for. Mutually exclusive with the nexthop parameter", + "length": 255, + "name": "gatewayid", + "related": "createPrivateGateway,createPrivateGateway,listPrivateGateways", + "required": false, + "type": "uuid" + }, { "description": "the vpc id for which the static route is created. This is required for nexthop parameter", "length": 255, @@ -19423,53 +19486,40 @@ "required": false, "since": "4.21.0", "type": "string" - }, - { - "description": "the gateway id we are creating static route for. Mutually exclusive with the nexthop parameter", - "length": 255, - "name": "gatewayid", - "related": "createPrivateGateway,createPrivateGateway,listPrivateGateways", - "required": false, - "type": "uuid" - }, - { - "description": "static route cidr", - "length": 255, - "name": "cidr", - "required": true, - "type": "string" } ], "related": "listStaticRoutes", "response": [ + {}, { - "description": "static route CIDR", - "name": "cidr", - "type": "string" - }, - { - "description": "the account associated with the static route", - "name": "account", - "type": "string" - }, - { - "description": "the project id of the static route", - "name": "projectid", + "description": "the domain path associated with the static route", + "name": "domainpath", "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "VPC gateway the route is created for", "name": "vpcgatewayid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the state of the static route", + "name": "state", + "type": "string" + }, + { + "description": "Next hop of the static route", + "name": "nexthop", "type": "string" }, { @@ -19478,8 +19528,8 @@ "type": "string" }, { - "description": "Next hop of the static route", - "name": "nexthop", + "description": "VPC the static route belongs to", + "name": "vpcid", "type": "string" }, { @@ -19488,8 +19538,33 @@ "type": "string" }, { - "description": "the domain path associated with the static route", - "name": "domainpath", + "description": "IP of VPC gateway the route is created for", + "name": "vpcgatewayip", + "type": "string" + }, + { + "description": "the domain associated with the static route", + "name": "domain", + "type": "string" + }, + { + "description": "static route CIDR", + "name": "cidr", + "type": "string" + }, + { + "description": "the project id of the static route", + "name": "projectid", + "type": "string" + }, + { + "description": "the account associated with the static route", + "name": "account", + "type": "string" + }, + { + "description": "the ID of the domain associated with the static route", + "name": "domainid", "type": "string" }, { @@ -19497,53 +19572,53 @@ "name": "tags", "response": [ { - "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 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 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": "tag value", + "name": "value", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the domain associated with the tag", + "name": "domain", "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 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": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -19553,33 +19628,6 @@ } ], "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", - "type": "string" - }, - { - "description": "VPC the static route belongs to", - "name": "vpcid", - "type": "string" - }, - {}, - { - "description": "the state of the static route", - "name": "state", - "type": "string" - }, - { - "description": "IP of VPC gateway the route is created for", - "name": "vpcgatewayip", - "type": "string" } ] }, @@ -19599,8 +19647,14 @@ ], "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {}, + { + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { @@ -19608,18 +19662,12 @@ "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" - } + {} ] }, { @@ -19627,13 +19675,6 @@ "isasync": false, "name": "updateDomain", "params": [ - { - "description": "updates domain with this name", - "length": 255, - "name": "name", - "required": false, - "type": "string" - }, { "description": "ID of domain to update", "length": 255, @@ -19642,6 +19683,13 @@ "required": true, "type": "uuid" }, + { + "description": "updates domain with this name", + "length": 255, + "name": "name", + "required": false, + "type": "string" + }, { "description": "Network domain for the domain's networks; empty string will update domainName with NULL value", "length": 255, @@ -19653,29 +19701,50 @@ "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 virtual machines available for this domain to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "the total volume being used by this domain", - "name": "volumetotal", + "description": "the domain ID of the parent domain", + "name": "parentdomainid", + "type": "string" + }, + { + "description": "the total number of snapshots stored by this domain", + "name": "snapshottotal", "type": "long" }, { - "description": "the total backup storage space (in GiB) the domain can own", - "name": "backupstoragelimit", - "type": "string" + "description": "details for the domain", + "name": "domaindetails", + "type": "map" }, + {}, { - "description": "the total volume available for this domain", - "name": "volumeavailable", + "description": "the total number of backups stored by this domain", + "name": "backuptotal", + "type": "long" + }, + { + "description": "the total backup storage space (in GiB) available to the domain", + "name": "backupstorageavailable", "type": "string" }, { - "description": "the date when this domain was created", - "name": "created", - "type": "date" + "description": "the level of the domain", + "name": "level", + "type": "integer" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the total number of templates which have been created by this domain", + "name": "templatetotal", + "type": "long" }, { "description": "the name of the domain", @@ -19683,49 +19752,48 @@ "type": "string" }, { - "description": "the total number of cpu cores the domain can own", - "name": "cpulimit", + "description": "the total number of backups available to this domain", + "name": "backupavailable", "type": "string" }, { - "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": "the total number of snapshots available for this domain", - "name": "snapshotavailable", - "type": "string" + "description": "the total number of buckets stored by this domain", + "name": "buckettotal", + "type": "long" }, - {}, { - "description": "the total volume which can be used by this domain", - "name": "volumelimit", + "description": "the ID of the domain", + "name": "id", "type": "string" }, { - "description": "the total number of vpcs the domain can own", - "name": "vpclimit", + "description": "the total number of projects the domain can own", + "name": "projectlimit", "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 number of projects being administrated by this domain", - "name": "projecttotal", + "description": "the total number of networks owned by domain", + "name": "networktotal", "type": "long" }, { - "description": "the total number of buckets available to this domain", - "name": "bucketavailable", + "description": "the state of the domain", + "name": "state", "type": "string" }, { - "description": "the state of the domain", - "name": "state", + "description": "the total number of gpus the domain can own", + "name": "gpulimit", "type": "string" }, { @@ -19734,74 +19802,68 @@ "type": "string" }, { - "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 UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, - {}, { - "description": "the total number of templates which can be created by this domain", - "name": "templatelimit", + "description": "the total number of virtual machines that can be deployed by this domain", + "name": "vmlimit", "type": "string" }, { - "description": "the total number of public ip addresses this domain can acquire", - "name": "iplimit", - "type": "string" + "description": "the total volume being used by this domain", + "name": "volumetotal", + "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total number of templates which can be created by this domain", + "name": "templatelimit", "type": "string" }, { - "description": "the ID of the domain", - "name": "id", + "description": "the total primary storage space (in GiB) available to be used for this domain", + "name": "primarystorageavailable", "type": "string" }, { - "description": "the total number of snapshots which can be stored by this domain", - "name": "snapshotlimit", + "description": "the total number of snapshots available for this domain", + "name": "snapshotavailable", "type": "string" }, { - "description": "the domain name of the parent domain", - "name": "parentdomainname", + "description": "the total number of networks the domain can own", + "name": "networklimit", "type": "string" }, { - "description": "the path of the domain", - "name": "path", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { - "description": "the total secondary storage space (in GiB) owned by domain", - "name": "secondarystoragetotal", - "type": "float" + "description": "the total primary storage space (in GiB) owned by domain", + "name": "primarystoragetotal", + "type": "long" }, { - "description": "the total secondary storage space (in GiB) available to be used for this domain", - "name": "secondarystorageavailable", + "description": "the total object storage space (in GiB) the domain can own", + "name": "objectstoragelimit", "type": "string" }, { - "description": "the total backup storage space (in GiB) owned by the domain", - "name": "backupstoragetotal", - "type": "long" + "description": "the total number of backups which can be stored by this domain", + "name": "backuplimit", + "type": "string" }, { - "description": "the total primary storage space (in GiB) available to be used for this domain", - "name": "primarystorageavailable", + "description": "the total number of cpu cores available to be created for this domain", + "name": "cpuavailable", "type": "string" }, { - "description": "the total primary storage space (in GiB) the domain can own", - "name": "primarystoragelimit", + "description": "the total object storage space (in GiB) available to the domain", + "name": "objectstorageavailable", "type": "string" }, { @@ -19810,159 +19872,155 @@ "type": "resourceiconresponse" }, { - "description": "the total number of cpu cores owned by domain", - "name": "cputotal", + "description": "the total number of public ip addresses allocated for this domain", + "name": "iptotal", "type": "long" }, { - "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": "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": "the total number of projects the domain can own", - "name": "projectlimit", + "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", + "description": "the total memory (in MB) available to be created for this domain", + "name": "memoryavailable", + "type": "string" + }, + { + "description": "the total number of gpus owned by domain", + "name": "gputotal", "type": "long" }, { - "description": "the network domain", - "name": "networkdomain", - "type": "string" + "description": "the date when this domain was created", + "name": "created", + "type": "date" }, { - "description": "the total backup storage space (in GiB) available to the domain", - "name": "backupstorageavailable", + "description": "the total backup storage space (in GiB) the domain can own", + "name": "backupstoragelimit", "type": "string" }, { - "description": "the domain ID of the parent domain", - "name": "parentdomainid", - "type": "string" + "description": "the total number of vpcs owned by domain", + "name": "vpctotal", + "type": "long" }, { - "description": "the total number of gpus the domain can own", - "name": "gpulimit", + "description": "the total volume which can be used by this domain", + "name": "volumelimit", "type": "string" }, { - "description": "the total number of projects available for administration by this domain", - "name": "projectavailable", + "description": "the total secondary storage space (in GiB) the domain can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "the total number of backups available to this domain", - "name": "backupavailable", + "description": "the total volume available for this domain", + "name": "volumeavailable", "type": "string" }, { - "description": "the total object storage space (in GiB) the domain can own", - "name": "objectstoragelimit", - "type": "string" + "description": "the total secondary storage space (in GiB) owned by domain", + "name": "secondarystoragetotal", + "type": "float" }, { - "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 secondary storage space (in GiB) available to be used for this domain", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "the total number of virtual machines that can be deployed by this domain", - "name": "vmlimit", + "description": "the total number of snapshots which can be stored by this domain", + "name": "snapshotlimit", "type": "string" }, { - "description": "the total number of backups stored by this domain", - "name": "backuptotal", + "description": "the total backup storage space (in GiB) owned by the domain", + "name": "backupstoragetotal", "type": "long" }, { - "description": "the total primary storage space (in GiB) owned by domain", - "name": "primarystoragetotal", + "description": "the total object storage space (in GiB) owned by the domain", + "name": "objectstoragetotal", "type": "long" }, { - "description": "the total number of snapshots stored by this domain", - "name": "snapshottotal", + "description": "the total number of projects being administrated by this domain", + "name": "projecttotal", "type": "long" }, { - "description": "the level of the domain", - "name": "level", - "type": "integer" + "description": "the total number of cpu cores the domain can own", + "name": "cpulimit", + "type": "string" }, + {}, { - "description": "the total number of virtual machines deployed by this domain", - "name": "vmtotal", - "type": "long" + "description": "the total number of public ip addresses available for this domain to acquire", + "name": "ipavailable", + "type": "string" }, { - "description": "the total number of networks the domain can own", - "name": "networklimit", + "description": "the total primary storage space (in GiB) the domain can own", + "name": "primarystoragelimit", "type": "string" }, { - "description": "the total number of networks available to be created for this domain", - "name": "networkavailable", + "description": "the path of the domain", + "name": "path", "type": "string" }, { - "description": "the total memory (in MB) owned by domain", - "name": "memorytotal", + "description": "the total number of cpu cores owned by domain", + "name": "cputotal", "type": "long" }, { - "description": "the total number of public ip addresses available for this domain to acquire", - "name": "ipavailable", - "type": "string" - }, - { - "description": "the total number of vpcs owned by domain", - "name": "vpctotal", + "description": "the total memory (in MB) owned by domain", + "name": "memorytotal", "type": "long" }, { - "description": "the total memory (in MB) available to be created for this domain", - "name": "memoryavailable", + "description": "the total number of buckets available to this domain", + "name": "bucketavailable", "type": "string" }, { - "description": "The tagged resource limit and count for the domain", - "name": "taggedresources", - "type": "list" + "description": "the domain name of the parent domain", + "name": "parentdomainname", + "type": "string" }, { - "description": "the total number of gpus owned by domain", - "name": "gputotal", - "type": "long" + "description": "whether the domain has one or more sub-domains", + "name": "haschild", + "type": "boolean" }, { - "description": "the total number of virtual machines available for this domain to acquire", - "name": "vmavailable", + "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", - "type": "long" - }, - { - "description": "the total number of public ip addresses allocated for this domain", - "name": "iptotal", - "type": "long" + "description": "the total number of networks available to be created for this domain", + "name": "networkavailable", + "type": "string" }, { "description": "true if the entity/resource has annotations", @@ -19970,24 +20028,14 @@ "type": "boolean" }, { - "description": "the total number of networks owned by domain", - "name": "networktotal", + "description": "the total number of virtual machines deployed by this domain", + "name": "vmtotal", "type": "long" }, { - "description": "the total memory (in MB) the domain can own", - "name": "memorylimit", - "type": "string" - }, - { - "description": "the total number of gpus available to be created for this domain", - "name": "gpuavailable", + "description": "the total number of vpcs the domain can own", + "name": "vpclimit", "type": "string" - }, - { - "description": "the total number of buckets stored by this domain", - "name": "buckettotal", - "type": "long" } ] }, @@ -20007,66 +20055,92 @@ ], "related": "enableAutoScaleVmGroup,listAutoScaleVmGroups,updateAutoScaleVmGroup", "response": [ + { + "description": "the public port", + "name": "publicport", + "type": "string" + }, { "description": "the name of the guest network the lb rule belongs to", "name": "associatednetworkname", "type": "string" }, + { + "description": "the number of available virtual machines (in Running, Starting, Stopping or Migrating state) in the vmgroup", + "name": "availablevirtualmachinecount", + "type": "int" + }, + { + "description": "list of scaleup autoscale policies", + "name": "scaleuppolicies", + "type": "list" + }, + {}, + { + "description": "the autoscale profile that contains information about the vms in the vm group.", + "name": "vmprofileid", + "type": "string" + }, { "description": "the account owning the vm group", "name": "account", "type": "string" }, { - "description": "the load balancer rule ID", - "name": "lbruleid", + "description": "the current state of the AutoScale Vm Group", + "name": "state", "type": "string" }, { - "description": "the lb provider of the guest network the lb rule belongs to", - "name": "lbprovider", + "description": "the project name of the vm group", + "name": "project", "type": "string" }, + {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the public ip address id", + "name": "publicipid", + "type": "string" }, - {}, { "description": "the id of the guest network the lb rule belongs to", "name": "associatednetworkid", "type": "string" }, { - "description": "the autoscale vm group ID", - "name": "id", - "type": "string" + "description": "the frequency at which the conditions have to be evaluated", + "name": "interval", + "type": "int" }, { - "description": "the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number.", - "name": "maxmembers", + "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 public ip address id", - "name": "publicipid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the domain ID of the vm group", - "name": "domainid", + "description": "the public ip address", + "name": "publicip", "type": "string" }, { - "description": "the project id of the vm group", - "name": "projectid", + "description": "the autoscale vm group ID", + "name": "id", "type": "string" }, { - "description": "list of scaledown autoscale policies", - "name": "scaledownpolicies", - "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.", + "name": "maxmembers", + "type": "int" + }, + { + "description": "the private port", + "name": "privateport", + "type": "string" }, { "description": "is group for display to the regular user", @@ -20074,29 +20148,24 @@ "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the domain name of the vm group", - "name": "domain", + "description": "the load balancer rule ID", + "name": "lbruleid", "type": "string" }, { - "description": "the public ip address", - "name": "publicip", - "type": "string" + "description": "the date when this vm group was created", + "name": "created", + "type": "date" }, { - "description": "the project name of the vm group", - "name": "project", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "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", @@ -20104,55 +20173,34 @@ "type": "integer" }, { - "description": "the number of available virtual machines (in Running, Starting, Stopping or Migrating state) in the vmgroup", - "name": "availablevirtualmachinecount", - "type": "int" + "description": "the domain name of the vm group", + "name": "domain", + "type": "string" }, { - "description": "the public port", - "name": "publicport", + "description": "the domain ID of the vm group", + "name": "domainid", "type": "string" }, { - "description": "the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number.", - "name": "minmembers", - "type": "int" + "description": "the project id of the vm group", + "name": "projectid", + "type": "string" }, - {}, { "description": "the name of the autoscale vm group ", "name": "name", "type": "string" }, { - "description": "list of scaleup autoscale policies", - "name": "scaleuppolicies", - "type": "list" - }, - { - "description": "the current state of the AutoScale Vm Group", - "name": "state", - "type": "string" - }, - { - "description": "the private port", - "name": "privateport", + "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": "path of the domain to which the vm group belongs", "name": "domainpath", "type": "string" - }, - { - "description": "the autoscale profile that contains information about the vms in the vm group.", - "name": "vmprofileid", - "type": "string" } ] }, @@ -20175,6 +20223,13 @@ "required": true, "type": "integer" }, + { + "description": "Map of tags (key/value pairs)", + "length": 255, + "name": "tags", + "required": false, + "type": "map" + }, { "description": "valid values are HOURLY, DAILY, WEEKLY, and MONTHLY", "length": 255, @@ -20182,15 +20237,6 @@ "required": true, "type": "string" }, - { - "description": "A comma-separated list of IDs of the storage pools in other zones in which the snapshot will be made available. The snapshot will always be made available in the zone in which the volume is present.", - "length": 255, - "name": "storageids", - "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", - "required": false, - "since": "4.21.0", - "type": "list" - }, { "description": "This parameter enables the option the snapshot to be copied to supported primary storage", "length": 255, @@ -20215,19 +20261,13 @@ "type": "boolean" }, { - "description": "the ID of the disk volume", - "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", - "required": true, - "type": "uuid" - }, - { - "description": "Map of tags (key/value pairs)", + "description": "A comma-separated list of IDs of the storage pools in other zones in which the snapshot will be made available. The snapshot will always be made available in the zone in which the volume is present.", "length": 255, - "name": "tags", + "name": "storageids", + "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", "required": false, - "type": "map" + "since": "4.21.0", + "type": "list" }, { "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.", @@ -20236,26 +20276,54 @@ "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "list" + }, + { + "description": "the ID of the disk volume", + "length": 255, + "name": "volumeid", + "related": "importVolume,attachVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", + "required": true, + "type": "uuid" } ], "related": "updateSnapshotPolicy,listSnapshotPolicies", "response": [ + { + "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": "maximum number of snapshots retained", + "name": "maxsnaps", + "type": "int" + }, + { + "description": "the time zone of the snapshot policy", + "name": "timezone", + "type": "string" + }, {}, + { + "description": "the name of the disk volume", + "name": "volumename", + "type": "string" + }, { "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 interval type of the snapshot policy", - "name": "intervaltype", - "type": "short" - }, { "description": "the ID of the snapshot policy", "name": "id", @@ -20265,11 +20333,6 @@ "description": "the list of resource tags associated", "name": "tags", "response": [ - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, { "description": "id of the resource", "name": "resourceid", @@ -20281,63 +20344,63 @@ "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 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 project id the tag belongs to", - "name": "projectid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "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", "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": "maximum number of snapshots retained", - "name": "maxsnaps", - "type": "int" - }, - { - "description": "the time zone of the snapshot policy", - "name": "timezone", - "type": "string" + "description": "The list of zones in which snapshot backup is scheduled", + "name": "zone", + "type": "set" }, { "description": "The list of pools in which snapshot backup is scheduled", @@ -20345,24 +20408,14 @@ "type": "set" }, { - "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": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "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": "time the snapshot is scheduled to be taken.", + "name": "schedule", + "type": "string" } ] }, @@ -20382,14 +20435,19 @@ ], "response": [ {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { @@ -20397,11 +20455,6 @@ "name": "success", "type": "boolean" }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, {} ], "since": "4.11" @@ -20415,13 +20468,12 @@ "description": "The ID of the volume to unmanage", "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", + "related": "importVolume,attachVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", "required": true, "type": "uuid" } ], "response": [ - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -20437,6 +20489,7 @@ "name": "success", "type": "boolean" }, + {}, { "description": "any text associated with the success or failure", "name": "displaytext", @@ -20451,6 +20504,13 @@ "isasync": false, "name": "createRolePermission", "params": [ + { + "description": "The rule permission, allow or deny. Default: deny.", + "length": 255, + "name": "permission", + "required": true, + "type": "string" + }, { "description": "The API name or wildcard rule such as list*", "length": 255, @@ -20472,23 +20532,26 @@ "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 description of the role permission", + "name": "description", + "type": "string" + }, + {}, + { + "description": "the permission type of the api name or wildcard rule, allow/deny", + "name": "permission", + "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", @@ -20499,31 +20562,21 @@ "name": "rule", "type": "string" }, - {}, - { - "description": "the ID of the role to which the role permission belongs", - "name": "roleid", - "type": "string" - }, { "description": "the ID of the role permission", - "name": "id", - "type": "string" - }, - { - "description": "the permission type of the api name or wildcard rule, allow/deny", - "name": "permission", - "type": "string" - }, - { - "description": "the description of the role permission", - "name": "description", + "name": "id", "type": "string" }, { "description": "the name of the role to which the role permission belongs", "name": "rolename", "type": "string" + }, + {}, + { + "description": "the ID of the role to which the role permission belongs", + "name": "roleid", + "type": "string" } ], "since": "4.9.0" @@ -20541,23 +20594,17 @@ "type": "string" }, { - "description": "the state of the system VM", - "length": 255, - "name": "state", - "required": false, - "type": "string" - }, - { - "description": "", + "description": "the host ID of the system VM", "length": 255, - "name": "page", + "name": "hostid", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "List by keyword", + "description": "the state of the system VM", "length": 255, - "name": "keyword", + "name": "state", "required": false, "type": "string" }, @@ -20569,6 +20616,13 @@ "required": false, "type": "uuid" }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, { "description": "the storage ID where vm's volumes belong to", "length": 255, @@ -20587,95 +20641,99 @@ "type": "uuid" }, { - "description": "CPU arch of the system VM", + "description": "the name of the system VM", "length": 255, - "name": "arch", + "name": "name", "required": false, - "since": "4.20.1", "type": "string" }, { - "description": "the host ID of the system VM", + "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 Pod ID of the system VM", + "description": "", "length": 255, - "name": "podid", - "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "the name of the system VM", + "description": "CPU arch of the system VM", "length": 255, - "name": "name", + "name": "arch", "required": false, + "since": "4.20.1", "type": "string" }, { - "description": "", + "description": "the Pod ID of the system VM", "length": 255, - "name": "pagesize", + "name": "podid", + "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", "required": false, - "type": "integer" + "type": "uuid" } ], "related": "migrateSystemVm,startSystemVm,changeServiceForSystemVm", "response": [ { - "description": "the systemvm agent version", - "name": "version", + "description": "the public MAC address for the system VM", + "name": "publicmacaddress", "type": "string" }, { - "description": "the network domain for the system VM", - "name": "networkdomain", + "description": "the Pod ID for the system VM", + "name": "podid", "type": "string" }, { - "description": "the first DNS for the system VM", - "name": "dns1", + "description": "guest vlan range", + "name": "guestvlan", "type": "string" }, { - "description": "the private netmask for the system VM", - "name": "privatenetmask", + "description": "the control state of the host for the system VM", + "name": "hostcontrolstate", "type": "string" }, { - "description": "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", + "description": "the public netmask for the system VM", + "name": "publicnetmask", "type": "string" }, { - "description": "the Zone name for the system VM", - "name": "zonename", + "description": "the Pod name for the system VM", + "name": "podname", "type": "string" }, { - "description": "the second DNS for the system VM", - "name": "dns2", + "description": "the private MAC address for the system VM", + "name": "privatemacaddress", "type": "string" }, { - "description": "the public IP address for the system VM", - "name": "publicip", + "description": "the systemvm agent version", + "name": "version", "type": "string" }, { - "description": "the gateway for the system VM", - "name": "gateway", - "type": "string" + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the number of active console sessions for the console proxy system vm", @@ -20683,14 +20741,13 @@ "type": "integer" }, { - "description": "the public MAC address for the system VM", - "name": "publicmacaddress", - "type": "string" + "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 state of the system VM", + "name": "state", "type": "string" }, { @@ -20698,100 +20755,96 @@ "name": "templatename", "type": "string" }, + {}, { - "description": "the control state of the host for the system VM", - "name": "hostcontrolstate", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the name of the system VM", - "name": "name", + "description": "the agent state of the system VM", + "name": "agentstate", "type": "string" }, { - "description": "the link local MAC address for the system vm", - "name": "linklocalmacaddress", + "description": "the ID of the system VM", + "name": "id", "type": "string" }, + {}, { - "description": "public vlan range", - "name": "publicvlan", - "type": "list" - }, - { - "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 ID of the service offering of the system virtual machine.", - "name": "serviceofferingid", + "description": "the link local netmask for the system vm", + "name": "linklocalnetmask", "type": "string" }, { - "description": "the Pod name for the system VM", - "name": "podname", + "description": "the link local MAC address for the system vm", + "name": "linklocalmacaddress", "type": "string" }, { - "description": "the link local IP address for the system vm", - "name": "linklocalip", + "description": "the host ID for the system VM", + "name": "hostid", "type": "string" }, - {}, { - "description": "the template ID for the system VM", - "name": "templateid", + "description": "the private netmask for the system VM", + "name": "privatenetmask", "type": "string" }, { - "description": "the agent state of the system VM", - "name": "agentstate", + "description": "the first DNS for the system VM", + "name": "dns1", "type": "string" }, { - "description": "the name of the service offering of the system virtual machine.", - "name": "serviceofferingname", - "type": "string" + "description": "public vlan range", + "name": "publicvlan", + "type": "list" }, { - "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 hostname for the system VM", - "name": "hostname", - "type": "string" + "description": "the last disconnected date of host", + "name": "disconnected", + "type": "date" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "the Zone ID for the system VM", + "name": "zoneid", + "type": "string" }, { - "description": "guest vlan range", - "name": "guestvlan", + "description": "the network domain for the system VM", + "name": "networkdomain", "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" }, { - "description": "the private IP address for the system VM", - "name": "privateip", + "description": "the name of the service offering of the system virtual machine.", + "name": "serviceofferingname", "type": "string" }, { - "description": "the ID of the system VM", - "name": "id", + "description": "the Zone name for the system VM", + "name": "zonename", "type": "string" }, { - "description": "the public netmask for the system VM", - "name": "publicnetmask", + "description": "the system VM type", + "name": "systemvmtype", "type": "string" }, { @@ -20800,38 +20853,38 @@ "type": "date" }, { - "description": "the private MAC address for the system VM", - "name": "privatemacaddress", + "description": "the hostname for the system VM", + "name": "hostname", "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 Zone ID for the system VM", - "name": "zoneid", + "description": "the gateway for the system VM", + "name": "gateway", "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 state of the system VM", - "name": "state", + "description": "the second DNS for the system VM", + "name": "dns2", "type": "string" }, { - "description": "the host ID for the system VM", - "name": "hostid", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the system VM type", - "name": "systemvmtype", + "description": "CPU arch of the system VM", + "name": "arch", "type": "string" } ] @@ -20842,60 +20895,60 @@ "name": "detachVolume", "params": [ { - "description": "the ID of the virtual machine where the volume is detached from", + "description": "the device ID on the virtual machine where volume is detached from", "length": 255, - "name": "virtualmachineid", - "related": "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": "deviceid", "required": false, - "type": "uuid" + "type": "long" }, { - "description": "the device ID on the virtual machine where volume is detached from", + "description": "the ID of the virtual machine where the volume is detached from", "length": 255, - "name": "deviceid", + "name": "virtualmachineid", + "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,createVMFromBackup,createVMFromBackup,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", "required": false, - "type": "long" + "type": "uuid" }, { "description": "the ID of the disk volume", "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", + "related": "importVolume,attachVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", "required": false, "type": "uuid" } ], - "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,resizeVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", + "related": "importVolume,attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,resizeVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", "response": [ { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "description": "cluster name where the volume is allocated", + "name": "clustername", "type": "string" }, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" + "description": "name of the availability zone", + "name": "zonename", + "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": "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", + "type": "long" }, { - "description": "min iops of the disk volume", - "name": "miniops", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { - "description": "name of the disk offering", - "name": "diskofferingname", - "type": "string" + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" }, { "description": "the path of the volume", @@ -20903,59 +20956,69 @@ "type": "string" }, { - "description": "pod id of the volume", - "name": "podid", + "description": "name of the disk volume", + "name": "name", "type": "string" }, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", - "type": "boolean" - }, - { - "description": "cluster id of the volume", - "name": "clusterid", + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "details for the volume repair result, they may vary for different hypervisors", - "name": "volumerepairresult", - "type": "map" + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", + "type": "string" }, { - "description": "the state of the disk volume", - "name": "state", + "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", + "description": "the bytes actually consumed on disk", + "name": "physicalsize", "type": "long" }, { - "description": "name of the disk volume", - "name": "name", + "description": "ID of the disk volume", + "name": "id", "type": "string" }, { - "description": "pod name of the volume", - "name": "podname", - "type": "string" + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" + }, + { + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", + "type": "boolean" + }, + { + "description": "the date the disk volume was created", + "name": "created", + "type": "date" + }, + { + "description": "details for the volume repair result, they may vary for different hypervisors", + "name": "volumerepairresult", + "type": "map" }, { "description": "the disk utilization", @@ -20963,82 +21026,77 @@ "type": "string" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "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": "true if the volume is extractable, false otherwise", "name": "isextractable", "type": "boolean" }, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { - "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": "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": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the 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": "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": "tag key name", - "name": "key", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -21050,34 +21108,44 @@ "type": "set" }, { - "description": "state of the virtual machine", - "name": "vmstate", - "type": "string" + "description": "size of the disk volume", + "name": "size", + "type": "long" }, { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "type": "string" }, { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", + "type": "boolean" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", + "description": "the bytes allocated", + "name": "virtualsize", "type": "long" }, { - "description": "type of the virtual machine", - "name": "vmtype", + "description": "max iops of the disk volume", + "name": "maxiops", + "type": "long" + }, + { + "description": "pod name of the volume", + "name": "podname", "type": "string" }, { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", - "type": "long" + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { "description": "the domain associated with the disk volume", @@ -21085,93 +21153,89 @@ "type": "string" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", + "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": "cluster name where the volume is allocated", - "name": "clustername", + "description": "type of the virtual machine", + "name": "vmtype", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", "type": "long" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "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", + "description": "the status of the volume", + "name": "status", "type": "string" }, { - "description": "max iops of the disk volume", - "name": "maxiops", + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", "type": "long" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "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", - "type": "long" - }, - { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", "type": "string" }, { - "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 virtual machine", - "name": "vmname", + "description": "state of the virtual machine", + "name": "vmstate", "type": "string" }, { - "description": "the account associated with the disk volume", - "name": "account", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", - "type": "long" + "description": "name of the primary storage hosting the disk volume", + "name": "storage", + "type": "string" }, + {}, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "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": "true if volume has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { @@ -21180,75 +21244,75 @@ "type": "string" }, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", - "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 name of the ISO attached to the virtual machine", + "name": "isoname", "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 the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the chain info of the volume", + "name": "chaininfo", + "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "pod id of the volume", + "name": "podid", "type": "string" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "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 boolean state of whether the volume is destroyed or not", - "name": "destroyed", - "type": "boolean" + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", + "type": "string" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "name of the disk offering", + "name": "diskofferingname", "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": "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": "true if volume has delete protection.", - "name": "deleteprotection", - "type": "boolean" + "description": "name of the virtual machine", + "name": "vmname", + "type": "string" }, { - "description": "ID of the availability zone", - "name": "zoneid", - "type": "string" + "description": "min iops of the disk volume", + "name": "miniops", + "type": "long" }, { "description": "details for the volume check result, they may vary for different hypervisors", @@ -21256,39 +21320,28 @@ "type": "map" }, { - "description": "the bytes allocated", - "name": "virtualsize", - "type": "long" - }, - { - "description": "ID of the disk volume", - "name": "id", - "type": "string" - }, - { - "description": "the format of the disk encryption if applicable", - "name": "encryptformat", + "description": "id of the virtual machine", + "name": "virtualmachineid", "type": "string" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", "type": "long" }, - {}, { - "description": "path of the Domain the disk volume belongs to", - "name": "domainpath", + "description": "cluster id of the volume", + "name": "clusterid", "type": "string" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "the state of the disk volume", + "name": "state", "type": "string" }, { - "description": "the chain info of the volume", - "name": "chaininfo", + "description": "path of the Domain the disk volume belongs to", + "name": "domainpath", "type": "string" } ] @@ -21298,14 +21351,6 @@ "isasync": true, "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", "length": 255, @@ -21314,6 +21359,14 @@ "required": true, "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" + }, { "description": "the ID of the private gateway", "length": 255, @@ -21324,23 +21377,23 @@ } ], "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", @@ -21354,44 +21407,59 @@ "name": "listTungstenFabricAddressGroup", "params": [ { - "description": "List by keyword", + "description": "the ID of zone", "length": 255, - "name": "keyword", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "", + "description": "the uuid of Tungsten-Fabric address group", "length": 255, - "name": "pagesize", + "name": "addressgroupuuid", "required": false, - "type": "integer" + "type": "string" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "the uuid of Tungsten-Fabric address group", + "description": "", "length": 255, - "name": "addressgroupuuid", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "the ID of zone", + "description": "", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" } ], "related": "createTungstenFabricAddressGroup", "response": [ + { + "description": "Tungsten-Fabric address group ip prefix", + "name": "ipprefix", + "type": "string" + }, + { + "description": "Tungsten-Fabric address group uuid", + "name": "uuid", + "type": "string" + }, + { + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -21402,36 +21470,21 @@ "name": "zoneid", "type": "long" }, - { - "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": "Tungsten-Fabric address group uuid", - "name": "uuid", - "type": "string" + "description": "Tungsten-Fabric address group ip prefix length", + "name": "ipprefixlen", + "type": "int" }, {}, - {}, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ] @@ -21452,35 +21505,35 @@ ], "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 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 driver for the host", + "name": "driver", "type": "string" }, - {}, { - "description": "the out-of-band management interface powerState of the host", - "name": "powerstate", - "type": "powerstate" + "description": "the out-of-band management interface address", + "name": "address", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the operation result description", + "name": "description", + "type": "string" }, { - "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", + "description": "the out-of-band management interface username", + "name": "username", "type": "string" }, { @@ -21494,30 +21547,30 @@ "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 operation result description", - "name": "description", - "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 out-of-band management action (if issued)", "name": "action", "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 operation result", - "name": "status", - "type": "boolean" } ], "since": "4.9.0" @@ -21542,18 +21595,10 @@ "since": "4.13", "type": "string" }, - { - "description": "linked domain", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", - "required": false, - "type": "uuid" - }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, @@ -21567,38 +21612,41 @@ { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" + }, + { + "description": "linked domain", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "required": false, + "type": "uuid" } ], "related": "searchLdap,importLdapUsers", "response": [ { - "description": "The user's principle", - "name": "principal", - "type": "string" - }, - { - "description": "The user's domain", - "name": "domain", + "description": "The authentication source for this user as known to the system or empty if the user is not yet in cloudstack.", + "name": "conflictingusersource", "type": "string" }, { - "description": "The 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 firstname", + "name": "firstname", "type": "string" }, {}, { - "description": "The user's username", - "name": "username", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The user's principle", + "name": "principal", + "type": "string" }, { "description": "The user's lastname", @@ -21606,19 +21654,24 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The user's email", + "name": "email", "type": "string" }, { - "description": "The user's firstname", - "name": "firstname", + "description": "The user's username", + "name": "username", "type": "string" }, {}, { - "description": "The user's email", - "name": "email", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "The user's domain", + "name": "domain", "type": "string" } ], @@ -21630,34 +21683,27 @@ "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": "Description of the schedule", "length": 255, - "name": "startdate", + "name": "description", "required": false, - "type": "date" + "type": "string" }, { - "description": "Enable VM schedule. Defaults to true", + "description": "end date after which the schedule becomes inactiveUse format \"yyyy-MM-dd hh:mm:ss\")", "length": 255, - "name": "enabled", + "name": "enddate", "required": false, - "type": "boolean" + "type": "date" }, { "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,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,createVMFromBackup,createVMFromBackup,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", "required": true, "type": "uuid" }, - { - "description": "Description of the schedule", - "length": 255, - "name": "description", - "required": false, - "type": "string" - }, { "description": "Specifies a timezone for this command. For more information on the timezone parameter, see TimeZone Format.", "length": 255, @@ -21665,6 +21711,13 @@ "required": true, "type": "string" }, + { + "description": "Enable VM schedule. Defaults to true", + "length": 255, + "name": "enabled", + "required": false, + "type": "boolean" + }, { "description": "Action to take on the VM (start/stop/reboot/force_stop/force_reboot).", "length": 255, @@ -21680,9 +21733,9 @@ "type": "string" }, { - "description": "end date after which the schedule becomes inactiveUse format \"yyyy-MM-dd hh:mm:ss\")", + "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": "enddate", + "name": "startdate", "required": false, "type": "date" } @@ -21690,38 +21743,35 @@ "related": "updateVMSchedule", "response": [ { - "description": "Timezone of the schedule", - "name": "timezone", - "type": "string" + "description": "Date after which the schedule becomes inactive", + "name": "enddate", + "type": "date" }, + {}, { - "description": "Date when the schedule was created", - "name": "created", - "type": "date" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { "description": "Action", "name": "action", "type": "action" }, - { - "description": "Description of VM schedule", - "name": "description", - "type": "string" - }, { "description": "Cron formatted VM schedule", "name": "schedule", "type": "string" }, + {}, { - "description": "ID of virtual machine", - "name": "virtualmachineid", + "description": "the ID of VM schedule", + "name": "id", "type": "string" }, { - "description": "Date from which the schedule is active", - "name": "startdate", + "description": "Date when the schedule was created", + "name": "created", "type": "date" }, { @@ -21730,27 +21780,30 @@ "type": "integer" }, { - "description": "VM schedule is enabled", - "name": "enabled", - "type": "boolean" + "description": "Description of VM schedule", + "name": "description", + "type": "string" }, { - "description": "the ID of VM schedule", - "name": "id", + "description": "Timezone of the schedule", + "name": "timezone", "type": "string" }, { - "description": "Date after which the schedule becomes inactive", - "name": "enddate", - "type": "date" + "description": "ID of virtual machine", + "name": "virtualmachineid", + "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "VM schedule is enabled", + "name": "enabled", + "type": "boolean" }, - {} + { + "description": "Date from which the schedule is active", + "name": "startdate", + "type": "date" + } ], "since": "4.19.0" }, @@ -21760,13 +21813,20 @@ "name": "listIpForwardingRules", "params": [ { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "Lists rule with the specified ID.", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "id", + "related": "createRoutingFirewallRule,listRoutingFirewallRules,createIpv6FirewallRule,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules", "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": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, @@ -21774,6 +21834,14 @@ "required": false, "type": "boolean" }, + { + "description": "Lists all rules applied to the specified VM.", + "length": 255, + "name": "virtualmachineid", + "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,createVMFromBackup,createVMFromBackup,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", + "required": false, + "type": "uuid" + }, { "description": "", "length": 255, @@ -21782,42 +21850,42 @@ "type": "integer" }, { - "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": "If set to false, list only resources belonging to the command's caller; if set to true - list resources 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": "Lists rule with the specified ID.", + "description": "", "length": 255, - "name": "id", - "related": "createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,updateIpv6FirewallRule", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "list only resources belonging to the domain specified", + "description": "list the rule belonging to this public IP address", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "name": "ipaddressid", + "related": "associateIpAddress,reserveIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", "required": false, "type": "uuid" }, { - "description": "Lists all rules applied to the specified VM.", + "description": "List by keyword", "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": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { "description": "list resources by account. Must be used with the domainId parameter.", @@ -21825,25 +21893,46 @@ "name": "account", "required": false, "type": "string" + } + ], + "related": "createRoutingFirewallRule,listRoutingFirewallRules,createIpv6FirewallRule,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule", + "response": [ + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "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": "list the rule belonging to this public IP address", - "length": 255, + "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 public ip address id for the port forwarding rule", "name": "ipaddressid", - "related": "associateIpAddress,reserveIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", - "required": false, - "type": "uuid" + "type": "string" + }, + { + "description": "the starting port of port forwarding rule's public port range", + "name": "publicport", + "type": "string" }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - } - ], - "related": "createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,createIpv6FirewallRule,updateIpv6FirewallRule", - "response": [ { "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", "name": "cidrlist", @@ -21854,14 +21943,20 @@ "name": "networkid", "type": "string" }, + {}, { - "description": "the vm ip address for the port forwarding rule", - "name": "vmguestip", + "description": "the ID of the port forwarding rule", + "name": "id", "type": "string" }, { - "description": "the ending port of port forwarding rule's private port range", - "name": "privateendport", + "description": "the 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" }, { @@ -21869,13 +21964,13 @@ "name": "tags", "response": [ { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -21884,108 +21979,66 @@ "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": "tag key name", - "name": "key", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "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": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" } ], "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", + "description": "the VM display name for the port forwarding rule", + "name": "virtualmachinedisplayname", "type": "string" }, { - "description": "the VM display name for the port forwarding rule", - "name": "virtualmachinedisplayname", + "description": "the ending port of port forwarding rule's private port range", + "name": "privateendport", "type": "string" }, { @@ -21994,8 +22047,8 @@ "type": "string" }, { - "description": "the public ip address id for the port forwarding rule", - "name": "ipaddressid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ] @@ -22005,13 +22058,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, @@ -22023,7 +22069,7 @@ "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", + "related": "importVolume,attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,resizeVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", "required": true, "type": "uuid" }, @@ -22036,6 +22082,13 @@ "since": "4.21.0", "type": "list" }, + { + "description": "asynchronous backup if true", + "length": 255, + "name": "asyncbackup", + "required": false, + "type": "boolean" + }, { "description": "A comma-separated list of IDs of the zones in which the snapshot will be made available. The snapshot will always be made available in the zone in which the volume is present.", "length": 255, @@ -22046,16 +22099,9 @@ "type": "list" }, { - "description": "the name of the snapshot", - "length": 255, - "name": "name", - "required": false, - "type": "string" - }, - { - "description": "asynchronous backup if true", + "description": "quiesce vm if true", "length": 255, - "name": "asyncbackup", + "name": "quiescevm", "required": false, "type": "boolean" }, @@ -22066,6 +22112,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, @@ -22082,37 +22136,60 @@ "type": "uuid" }, { - "description": "policy id of the snapshot, if this is null, then use MANUAL_POLICY.", + "description": "This parameter enables the option the snapshot to be copied to supported primary storage", "length": 255, - "name": "policyid", - "related": "updateSnapshotPolicy,listSnapshotPolicies", + "name": "usestoragereplication", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "quiesce vm if true", + "description": "the name of the snapshot", "length": 255, - "name": "quiescevm", + "name": "name", "required": false, - "type": "boolean" + "type": "string" } ], "related": "createSnapshotFromVMSnapshot,copySnapshot,archiveSnapshot,listSnapshots,revertSnapshot,listSnapshots", "response": [ - {}, { - "description": "name of the availability zone", - "name": "zonename", + "description": "the project name of the snapshot", + "name": "project", "type": "string" }, { - "description": "name of the datastore for the snapshot entry", - "name": "datastorename", + "description": "virtual size of backedup snapshot on image store", + "name": "virtualsize", + "type": "long" + }, + { + "description": "the state of the snapshot. BackedUp means that snapshot is ready to be used; Creating - the snapshot is being allocated on the primary storage; BackingUp - the snapshot is being backed up on secondary storage", + "name": "state", + "type": "state" + }, + { + "description": "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": "download progress of a snapshot", + "name": "downloaddetails", + "type": "map" + }, + { + "description": "type of the datastore for the snapshot entry", + "name": "datastoretype", "type": "string" }, { - "description": "state of the snapshot on the datastore", - "name": "datastorestate", + "description": "type of the disk volume", + "name": "volumetype", + "type": "string" + }, + { + "description": "display name of the os on volume", + "name": "osdisplayname", "type": "string" }, { @@ -22121,49 +22198,86 @@ "type": "string" }, { - "description": "ID of the disk volume", - "name": "volumeid", + "description": "id of the os on volume", + "name": "ostypeid", "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 status of the template", + "name": "status", + "type": "string" }, { - "description": "display name of the os on volume", - "name": "osdisplayname", + "description": "indicates whether the underlying storage supports reverting the volume to this snapshot", + "name": "revertable", + "type": "boolean" + }, + { + "description": "name of the datastore for the snapshot entry", + "name": "datastorename", "type": "string" }, + {}, { - "description": "ID of the datastore for the snapshot entry", - "name": "datastoreid", + "description": "state of the disk volume", + "name": "volumestate", "type": "string" }, { - "description": " the date the snapshot was created", - "name": "created", - "type": "date" + "description": "the project id of the snapshot", + "name": "projectid", + "type": "string" }, { - "description": "virtual size of backedup snapshot on image store", - "name": "virtualsize", - "type": "long" + "description": "name of the availability zone", + "name": "zonename", + "type": "string" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the type of the snapshot", + "name": "snapshottype", + "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": "state of the snapshot on the datastore", + "name": "datastorestate", + "type": "string" }, { - "description": "physical size of backedup snapshot on image store", - "name": "physicalsize", - "type": "long" + "description": "id of the availability zone", + "name": "zoneid", + "type": "string" + }, + { + "description": "the account associated with the snapshot", + "name": "account", + "type": "string" + }, + { + "description": "the domain ID of the snapshot's account", + "name": "domainid", + "type": "string" + }, + { + "description": "path of the Domain the snapshot's account belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "name of the disk volume", + "name": "volumename", + "type": "string" + }, + { + "description": "the domain name of the snapshot's account", + "name": "domain", + "type": "string" + }, + { + "description": "ID of the datastore for the snapshot entry", + "name": "datastoreid", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", @@ -22171,23 +22285,38 @@ "type": "string" }, { - "description": "id of the os on volume", - "name": "ostypeid", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "valid location types are primary and secondary.", + "name": "locationtype", "type": "string" }, { - "description": "the project id of the snapshot", - "name": "projectid", + "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": "valid types are hourly, daily, weekly, monthy, template, and none.", + "name": "intervaltype", "type": "string" }, { - "description": "the status of the template", - "name": "status", + "description": "ID of the disk volume", + "name": "volumeid", "type": "string" }, { - "description": "id of the availability zone", - "name": "zoneid", + "description": "name of the snapshot", + "name": "name", "type": "string" }, { @@ -22195,33 +22324,33 @@ "name": "tags", "response": [ { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -22235,103 +22364,27 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "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 domain associated with the tag", - "name": "domain", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], "type": "set" }, { - "description": "name of the snapshot", - "name": "name", - "type": "string" - }, - { - "description": "indicates whether the underlying storage supports reverting the volume to this snapshot", - "name": "revertable", - "type": "boolean" - }, - { - "description": "valid location types are primary and secondary.", - "name": "locationtype", - "type": "string" - }, - { - "description": "download progress of a snapshot", - "name": "downloaddetails", - "type": "map" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the project name of the snapshot", - "name": "project", - "type": "string" - }, - { - "description": "type of the datastore for the snapshot entry", - "name": "datastoretype", - "type": "string" - }, - {}, - { - "description": "valid types are hourly, daily, weekly, monthy, template, and none.", - "name": "intervaltype", - "type": "string" - }, - { - "description": "state of the disk volume", - "name": "volumestate", - "type": "string" - }, - { - "description": "the account associated with the snapshot", - "name": "account", - "type": "string" - }, - { - "description": "the type of the snapshot", - "name": "snapshottype", - "type": "string" - }, - { - "description": "name of the disk volume", - "name": "volumename", - "type": "string" - }, - { - "description": "type of the disk volume", - "name": "volumetype", - "type": "string" - }, - { - "description": "path of the Domain the snapshot's account belongs to", - "name": "domainpath", - "type": "string" - }, - { - "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": "physical size of backedup snapshot on image store", + "name": "physicalsize", + "type": "long" } ] }, @@ -22341,35 +22394,34 @@ "name": "listStoragePoolsMetrics", "params": [ { - "description": "the Pod ID for the storage pool", + "description": "If true, lists the custom stats of the storage pool", "length": 255, - "name": "podid", - "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", + "name": "storagecustomstats", "required": false, - "type": "uuid" + "since": "4.18.1", + "type": "boolean" }, { - "description": "the ID of the storage pool", + "description": "the IP address for the storage pool", "length": 255, - "name": "id", - "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "name": "ipaddress", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "If true, lists the custom stats of the storage pool", + "description": "the name of the storage access group", "length": 255, - "name": "storagecustomstats", + "name": "storageaccessgroup", "required": false, - "since": "4.18.1", - "type": "boolean" + "since": "4.21.0", + "type": "string" }, { "description": "the status of the storage pool", @@ -22379,9 +22431,18 @@ "type": "string" }, { - "description": "the name of the storage pool", + "description": "the Zone ID for the storage pool", "length": 255, - "name": "name", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "uuid" + }, + { + "description": "the scope of the storage pool", + "length": 255, + "name": "scope", + "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", "required": false, "type": "string" }, @@ -22394,40 +22455,32 @@ "type": "uuid" }, { - "description": "host ID of the storage pools", + "description": "the Pod ID for the storage pool", "length": 255, - "name": "hostid", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,addBaremetalHost", + "name": "podid", + "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", "required": false, "type": "uuid" }, { - "description": "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 Zone ID for the storage pool", + "description": "the ID of the storage pool", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "id", + "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", "required": false, "type": "uuid" }, { - "description": "the storage pool path", - "length": 255, - "name": "path", - "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" }, @@ -22439,63 +22492,77 @@ "type": "integer" }, { - "description": "the scope of the storage pool", + "description": "the storage pool path", "length": 255, - "name": "scope", - "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "name": "path", "required": false, "type": "string" }, { - "description": "List by keyword", + "description": "host ID of the storage pools", "length": 255, - "name": "keyword", + "name": "hostid", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost", "required": false, - "type": "string" + "type": "uuid" } ], "related": "", "response": [ { - "description": "disk size unallocated in GiB", - "name": "disksizeunallocatedgb", + "description": "the date and time the storage pool was created", + "name": "created", + "type": "date" + }, + { + "description": "the IP address of the storage pool", + "name": "ipaddress", "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": "whether this pool is managed or not", - "name": "managed", - "type": "boolean" + "description": "the total disk size of the storage pool", + "name": "disksizetotal", + "type": "long" }, { - "description": "the storage pool custom stats", - "name": "storagecustomstats", - "type": "map" + "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": "Storage provider for this pool", + "name": "provider", + "type": "string" + }, + { + "description": "the storage pool capabilities", + "name": "storagecapabilities", + "type": "map" }, - {}, { "description": "the storage access groups for the storage pool", "name": "storageaccessgroups", "type": "string" }, { - "description": "the name of the cluster for the storage pool", - "name": "clustername", + "description": "the name of the storage pool", + "name": "name", "type": "string" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", - "type": "long" + "description": "the storage pool details", + "name": "details", + "type": "map" + }, + { + "description": "the overprovisionfactor for the storage pool", + "name": "overprovisionfactor", + "type": "string" }, { "description": "disk size in GiB", @@ -22503,64 +22570,70 @@ "type": "string" }, { - "description": "storage allocated disable threshold exceeded", - "name": "storageallocateddisablethreshold", - "type": "boolean" + "description": "the ID of the storage pool", + "name": "id", + "type": "string" }, { - "description": "the hypervisor type of the storage pool", - "name": "hypervisor", + "description": "disk size unallocated in GiB", + "name": "disksizeunallocatedgb", "type": "string" }, { - "description": "storage allocated notification threshold exceeded", - "name": "storageallocatedthreshold", - "type": "boolean" + "description": "the Zone ID of the storage pool", + "name": "zoneid", + "type": "string" }, { - "description": "the nfs mount options for the storage pool", - "name": "nfsmountopts", - "type": "string" + "description": "the pool's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" + }, + { + "description": "total IOPS currently in use", + "name": "usediops", + "type": "long" }, { "description": "the scope of the storage pool", "name": "scope", "type": "string" }, + {}, { - "description": "disk size allocated in GiB", - "name": "disksizeallocatedgb", - "type": "string" + "description": "the storage pool custom stats", + "name": "storagecustomstats", + "type": "map" }, { - "description": "the Pod name of the storage pool", - "name": "podname", + "description": "disk size used in GiB", + "name": "disksizeusedgb", "type": "string" }, { - "description": "the storage pool details", - "name": "details", - "type": "map" + "description": "the tags for the storage pool", + "name": "tags", + "type": "string" }, { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", + "description": "storage usage disable threshold exceeded", + "name": "storageusagedisablethreshold", "type": "boolean" }, { - "description": "the storage pool capabilities", - "name": "storagecapabilities", - "type": "map" + "description": "the nfs mount options for the storage pool", + "name": "nfsmountopts", + "type": "string" }, { - "description": "total min IOPS currently in use by volumes", - "name": "allocatediops", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "storage usage disable threshold exceeded", - "name": "storageusagedisablethreshold", - "type": "boolean" + "description": "the storage pool type", + "name": "type", + "type": "string" }, { "description": "the state of the storage pool", @@ -22573,101 +22646,86 @@ "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", - "type": "string" - }, - { - "description": "the name of the storage pool", - "name": "name", - "type": "string" - }, - { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", + "description": "total min IOPS currently in use by volumes", + "name": "allocatediops", "type": "long" }, - {}, { - "description": "the total disk size of the storage pool", - "name": "disksizetotal", + "description": "bytes CloudStack can provision from this storage pool", + "name": "capacitybytes", "type": "long" }, { - "description": "the date and time the storage pool was created", - "name": "created", - "type": "date" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the storage pool type", - "name": "type", + "description": "disk size allocated in GiB", + "name": "disksizeallocatedgb", "type": "string" }, { - "description": "the Zone ID of the storage pool", - "name": "zoneid", + "description": "the Zone name of the storage pool", + "name": "zonename", "type": "string" }, + { + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" + }, + { + "description": "storage allocated notification threshold exceeded", + "name": "storageallocatedthreshold", + "type": "boolean" + }, { "description": "the storage pool path", "name": "path", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "storage usage notification threshold exceeded", + "name": "storageusagethreshold", + "type": "boolean" }, { - "description": "Storage provider for this pool", - "name": "provider", + "description": "the Pod name of the storage pool", + "name": "podname", "type": "string" }, { - "description": "disk size used in GiB", - "name": "disksizeusedgb", + "description": "the hypervisor type of the storage pool", + "name": "hypervisor", "type": "string" }, { - "description": "IOPS CloudStack can provision from this storage pool", - "name": "capacityiops", - "type": "long" - }, - { - "description": "the ID of the cluster for the storage pool", - "name": "clusterid", + "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", - "type": "string" + "description": "whether this pool is managed or not", + "name": "managed", + "type": "boolean" }, + {}, { - "description": "the overprovisionfactor for the storage pool", - "name": "overprovisionfactor", - "type": "string" + "description": "the pool's currently used disk size", + "name": "disksizeused", + "type": "long" }, { - "description": "storage usage notification threshold exceeded", - "name": "storageusagethreshold", + "description": "storage allocated disable threshold exceeded", + "name": "storageallocateddisablethreshold", "type": "boolean" }, { - "description": "the tags for the storage pool", - "name": "tags", + "description": "the name of the cluster for the storage pool", + "name": "clustername", "type": "string" }, - { - "description": "total IOPS currently in use", - "name": "usediops", - "type": "long" - }, { "description": "true if this pool is suitable to migrate a volume, false otherwise", "name": "suitableformigration", @@ -22677,106 +22735,113 @@ "since": "4.9.3" }, { - "description": "Create a new keypair and returns the private key", + "description": "Update a backup repository", "isasync": false, - "name": "createSSHKeyPair", + "name": "updateBackupRepository", "params": [ { - "description": "an optional project for the ssh key", + "description": "address of the backup repository", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "address", "required": false, + "type": "string" + }, + { + "description": "ID of the backup repository", + "length": 255, + "name": "id", + "related": "addBackupRepository,updateBackupRepository,listBackupRepositories", + "required": true, "type": "uuid" }, { - "description": "an optional account for the ssh key. Must be used with domainId.", + "description": "shared storage mount options", "length": 255, - "name": "account", + "name": "mountopts", "required": false, "type": "string" }, { - "description": "Name of the keypair", + "description": "name of the backup repository", "length": 255, "name": "name", - "required": true, + "required": false, "type": "string" }, { - "description": "an optional domainId for the ssh key. If the account parameter is used, domainId must also be used.", + "description": "backups in this repository can be used to create Instances on all Zones", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "name": "crosszoneinstancecreation", "required": false, - "type": "uuid" + "type": "boolean" } ], - "related": "", + "related": "addBackupRepository,listBackupRepositories", "response": [ { - "description": "Private key", - "name": "privatekey", - "type": "string" - }, - { - "description": "Fingerprint of the public key", - "name": "fingerprint", + "description": "the ID of the backup repository", + "name": "id", "type": "string" }, { - "description": "ID of the ssh keypair", - "name": "id", + "description": "name of the provider", + "name": "provider", "type": "string" }, { - "description": "the project name of the keypair owner", - "name": "project", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "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": "the date and time the backup repository was added", + "name": "created", + "type": "date" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the Zone name of the backup repository", + "name": "zonename", "type": "string" }, { - "description": "Name of the keypair", - "name": "name", + "description": "the address / url of the backup repository", + "name": "address", "type": "string" }, + {}, { - "description": "the owner of the keypair", - "name": "account", - "type": "string" + "description": "capacity of the backup repository", + "name": "capacitybytes", + "type": "long" }, { - "description": "the project id of the keypair owner", - "name": "projectid", + "description": "backup type", + "name": "type", "type": "string" }, + {}, { - "description": "the domain name of the keypair owner", - "name": "domain", + "description": "the Zone ID of the backup repository", + "name": "zoneid", "type": "string" }, - {}, - {}, { - "description": "the domain id of the keypair owner", - "name": "domainid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the name of the backup repository", + "name": "name", "type": "string" } - ] + ], + "since": "4.22.0" }, { "description": "Deletes a backup offering", @@ -22793,19 +22858,72 @@ } ], "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.14.0" + }, + { + "description": "Create a new keypair and returns the private key", + "isasync": false, + "name": "createSSHKeyPair", + "params": [ + { + "description": "an optional account for the ssh key. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, + "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "an optional project for the ssh key", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "uuid" + }, + { + "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": "Name of the keypair", + "length": 255, + "name": "name", + "required": true, + "type": "string" + } + ], + "related": "", + "response": [ + { + "description": "the project id of the keypair owner", + "name": "projectid", "type": "string" }, {}, @@ -22814,9 +22932,58 @@ "name": "jobstatus", "type": "integer" }, - {} - ], - "since": "4.14.0" + { + "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 owner of the keypair", + "name": "account", + "type": "string" + }, + { + "description": "Name of the keypair", + "name": "name", + "type": "string" + }, + { + "description": "Fingerprint of the public key", + "name": "fingerprint", + "type": "string" + }, + { + "description": "the domain id of the keypair owner", + "name": "domainid", + "type": "string" + }, + { + "description": "the project name of the keypair owner", + "name": "project", + "type": "string" + }, + { + "description": "ID of the ssh keypair", + "name": "id", + "type": "string" + }, + {}, + { + "description": "the domain name of the keypair owner", + "name": "domain", + "type": "string" + }, + { + "description": "Private key", + "name": "privatekey", + "type": "string" + } + ] }, { "description": "list Tungsten-Fabric service group", @@ -22824,20 +22991,12 @@ "name": "listTungstenFabricServiceGroup", "params": [ { - "description": "List by keyword", + "description": "the uuid of Tungsten-Fabric service group", "length": 255, - "name": "keyword", + "name": "servicegroupuuid", "required": false, "type": "string" }, - { - "description": "the ID of zone", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" - }, { "description": "", "length": 255, @@ -22846,9 +23005,9 @@ "type": "integer" }, { - "description": "the uuid of Tungsten-Fabric service group", + "description": "List by keyword", "length": 255, - "name": "servicegroupuuid", + "name": "keyword", "required": false, "type": "string" }, @@ -22858,19 +23017,27 @@ "name": "page", "required": false, "type": "integer" + }, + { + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "uuid" } ], "related": "createTungstenFabricServiceGroup", "response": [ { - "description": "Tungsten-Fabric service group uuid", - "name": "uuid", + "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": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { "description": "Tungsten-Fabric service group protocol", @@ -22878,36 +23045,36 @@ "type": "string" }, { - "description": "Tungsten-Fabric service group name", - "name": "name", - "type": "string" + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" }, + {}, { "description": "Tungsten-Fabric service group end port", "name": "endport", "type": "int" }, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "Tungsten-Fabric service group uuid", + "name": "uuid", + "type": "string" }, - {}, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Tungsten-Fabric service group name", + "name": "name", "type": "string" }, { "description": "Tungsten-Fabric service group start port", "name": "startport", "type": "int" - }, - { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", - "type": "string" } ] }, @@ -22917,11 +23084,33 @@ "name": "authorizeSecurityGroupEgress", "params": [ { - "description": "user to security group mapping", + "description": "The name of the security group. Mutually exclusive with securityGroupId parameter", "length": 255, - "name": "usersecuritygrouplist", + "name": "securitygroupname", "required": false, - "type": "map" + "type": "string" + }, + { + "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": "type of the icmp message being sent", + "length": 255, + "name": "icmptype", + "required": false, + "type": "integer" + }, + { + "description": "start port for this egress rule", + "length": 255, + "name": "startport", + "required": false, + "type": "integer" }, { "description": "the cidr list associated. Multiple entries must be separated by a single comma character (,).", @@ -22931,19 +23120,11 @@ "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": "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", @@ -22954,19 +23135,12 @@ "type": "uuid" }, { - "description": "type of the icmp message being sent", + "description": "end port for this egress rule", "length": 255, - "name": "icmptype", + "name": "endport", "required": false, "type": "integer" }, - { - "description": "TCP is default. UDP is the other supported protocol", - "length": 255, - "name": "protocol", - "required": false, - "type": "string" - }, { "description": "an optional project of the security group", "length": 255, @@ -22976,23 +23150,16 @@ "type": "uuid" }, { - "description": "start port for this egress rule", - "length": 255, - "name": "startport", - "required": false, - "type": "integer" - }, - { - "description": "The name of the security group. Mutually exclusive with securityGroupId parameter", + "description": "TCP is default. UDP is the other supported protocol", "length": 255, - "name": "securitygroupname", + "name": "protocol", "required": false, "type": "string" }, { - "description": "end port for this egress rule", + "description": "error code for this icmp message", "length": 255, - "name": "endport", + "name": "icmpcode", "required": false, "type": "integer" }, @@ -23007,8 +23174,8 @@ "related": "authorizeSecurityGroupIngress", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the starting IP of the security group rule", + "name": "startport", "type": "integer" }, { @@ -23017,13 +23184,18 @@ "type": "string" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "account owning the security group rule", + "name": "account", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { @@ -23032,67 +23204,68 @@ "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 list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "the account associated with the tag", - "name": "account", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "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": "path of the Domain associated with the tag", + "name": "domainpath", "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": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "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": "tag value", + "name": "value", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the account associated with the tag", + "name": "account", "type": "string" } ], @@ -23100,31 +23273,25 @@ }, {}, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", + "description": "the ending IP of the security group rule ", + "name": "endport", "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", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", + "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" + } ], "since": "3.0.0" }, @@ -23134,11 +23301,12 @@ "name": "listStoragePools", "params": [ { - "description": "List by keyword", + "description": "host ID of the storage pools", "length": 255, - "name": "keyword", + "name": "hostid", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost", "required": false, - "type": "string" + "type": "uuid" }, { "description": "the storage pool path", @@ -23164,33 +23332,43 @@ "type": "uuid" }, { - "description": "the Pod ID for the storage pool", + "description": "the ID of the storage pool", "length": 255, - "name": "podid", - "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", + "name": "id", + "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", "required": false, "type": "uuid" }, { - "description": "the IP address for the storage pool", + "description": "", "length": 255, - "name": "ipaddress", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "", + "description": "the Pod ID for the storage pool", "length": 255, - "name": "pagesize", + "name": "podid", + "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "the name of the storage pool", + "description": "If true, lists the custom stats of the storage pool", "length": 255, - "name": "name", + "name": "storagecustomstats", "required": false, - "type": "string" + "since": "4.18.1", + "type": "boolean" + }, + { + "description": "list storage pools belonging to the specific cluster", + "length": 255, + "name": "clusterid", + "related": "addCluster,updateCluster", + "required": false, + "type": "uuid" }, { "description": "the name of the storage access group", @@ -23201,36 +23379,32 @@ "type": "string" }, { - "description": "the ID of the storage pool", + "description": "the IP address for the storage pool", "length": 255, - "name": "id", - "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "name": "ipaddress", "required": false, - "type": "uuid" + "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": "List by keyword", "length": 255, - "name": "storagecustomstats", + "name": "keyword", "required": false, - "since": "4.18.1", - "type": "boolean" + "type": "string" }, { - "description": "host ID of the storage pools", + "description": "", "length": 255, - "name": "hostid", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,addBaremetalHost", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { "description": "the status of the storage pool", @@ -23238,21 +23412,14 @@ "name": "status", "required": false, "type": "string" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" } ], "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", "response": [ { - "description": "the date and time the storage pool was created", - "name": "created", - "type": "date" + "description": "the pool's currently used disk size", + "name": "disksizeused", + "type": "long" }, { "description": "the storage access groups for the storage pool", @@ -23260,34 +23427,29 @@ "type": "string" }, { - "description": "the IP address of the storage pool", - "name": "ipaddress", + "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", + "description": "the storage pool path", + "name": "path", "type": "string" }, { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", - "type": "boolean" - }, - { - "description": "the storage pool capabilities", - "name": "storagecapabilities", - "type": "map" + "description": "the Zone name of the storage pool", + "name": "zonename", + "type": "string" }, { - "description": "the name of the cluster for the storage pool", - "name": "clustername", + "description": "the IP address of the storage pool", + "name": "ipaddress", "type": "string" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "the storage pool details", + "name": "details", + "type": "map" }, { "description": "the total disk size of the storage pool", @@ -23295,38 +23457,44 @@ "type": "long" }, { - "description": "the storage pool custom stats", - "name": "storagecustomstats", - "type": "map" + "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 Pod name of the storage pool", + "name": "podname", + "type": "string" }, { - "description": "the storage pool type", - "name": "type", - "type": "string" + "description": "total min IOPS currently in use by volumes", + "name": "allocatediops", + "type": "long" }, { - "description": "the storage pool path", - "name": "path", - "type": "string" + "description": "the storage pool capabilities", + "name": "storagecapabilities", + "type": "map" }, { - "description": "true if this pool is suitable to migrate a volume, false otherwise", - "name": "suitableformigration", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, + { + "description": "the ID of the cluster for the storage pool", + "name": "clusterid", + "type": "string" + }, { "description": "the Zone ID of the storage pool", "name": "zoneid", "type": "string" }, + {}, { - "description": "Storage provider for this pool", - "name": "provider", + "description": "the Pod ID of the storage pool", + "name": "podid", "type": "string" }, { @@ -23334,97 +23502,101 @@ "name": "capacityiops", "type": "long" }, - {}, { - "description": "the name of the storage pool", - "name": "name", - "type": "string" + "description": "total IOPS currently in use", + "name": "usediops", + "type": "long" }, { - "description": "the overprovisionfactor for the storage pool", - "name": "overprovisionfactor", + "description": "the state of the storage pool", + "name": "state", + "type": "storagepoolstatus" + }, + { + "description": "Storage provider for this pool", + "name": "provider", "type": "string" }, - {}, { - "description": "the scope of the storage pool", - "name": "scope", + "description": "the tags for the storage pool", + "name": "tags", "type": "string" }, + {}, { - "description": "total IOPS currently in use", - "name": "usediops", - "type": "long" + "description": "the date and time the storage pool was created", + "name": "created", + "type": "date" }, { - "description": "the Pod ID of the storage pool", - "name": "podid", + "description": "the overprovisionfactor for the storage pool", + "name": "overprovisionfactor", "type": "string" }, { - "description": "whether this pool is managed or not", - "name": "managed", - "type": "boolean" + "description": "the pool's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" }, { - "description": "the storage pool details", - "name": "details", - "type": "map" + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" }, { - "description": "the nfs mount options for the storage pool", - "name": "nfsmountopts", + "description": "the name of the cluster for the storage pool", + "name": "clustername", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the storage pool custom stats", + "name": "storagecustomstats", + "type": "map" }, { - "description": "the tags for the storage pool", - "name": "tags", - "type": "string" + "description": "true if this pool is suitable to migrate a volume, false otherwise", + "name": "suitableformigration", + "type": "boolean" }, { - "description": "the hypervisor type of the storage pool", - "name": "hypervisor", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", + "description": "bytes CloudStack can provision from this storage pool", + "name": "capacitybytes", "type": "long" }, { - "description": "the Pod name of the storage pool", - "name": "podname", - "type": "string" - }, - { - "description": "the ID of the cluster for the storage pool", - "name": "clusterid", + "description": "the hypervisor type of the storage pool", + "name": "hypervisor", "type": "string" }, { - "description": "total min IOPS currently in use by volumes", - "name": "allocatediops", - "type": "long" + "description": "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", + "description": "the storage pool type", + "name": "type", "type": "string" }, { - "description": "the state of the storage pool", - "name": "state", - "type": "storagepoolstatus" + "description": "the nfs mount options for the storage pool", + "name": "nfsmountopts", + "type": "string" }, { "description": "the ID of the storage pool", "name": "id", "type": "string" + }, + { + "description": "the name of the storage pool", + "name": "name", + "type": "string" } ] }, @@ -23434,32 +23606,25 @@ "name": "updateHypervisorCapabilities", "params": [ { - "description": "set true to enable security group for this hypervisor.", - "length": 255, - "name": "securitygroupenabled", - "required": false, - "type": "boolean" - }, - { - "description": "the maximum number of the hypervisor hosts per cluster ", + "description": "the maximum number of Data Volumes that can be attached to a VM for this hypervisor.", "length": 255, - "name": "maxhostspercluster", + "name": "maxdatavolumeslimit", "required": false, "since": "4.16.0", "type": "integer" }, { - "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": "the maximum number of the hypervisor hosts per cluster ", "length": 255, - "name": "maxdatavolumeslimit", + "name": "maxhostspercluster", "required": false, "since": "4.16.0", "type": "integer" @@ -23472,6 +23637,13 @@ "required": false, "type": "uuid" }, + { + "description": "the max number of Guest VMs per host for this hypervisor.", + "length": 255, + "name": "maxguestslimit", + "required": false, + "type": "long" + }, { "description": "set true to enable VM snapshots for this hypervisor", "length": 255, @@ -23481,66 +23653,60 @@ "type": "boolean" }, { - "description": "the hypervisor for which the hypervisor capabilities are to be updated", + "description": "the hypervisor version for which the hypervisor capabilities are to be updated", "length": 255, - "name": "hypervisor", + "name": "hypervisorversion", "required": false, "since": "4.19.1", "type": "string" }, { - "description": "the hypervisor version for which the hypervisor capabilities are to be updated", + "description": "set true to enable security group for this hypervisor.", "length": 255, - "name": "hypervisorversion", + "name": "securitygroupenabled", "required": false, - "since": "4.19.1", - "type": "string" + "type": "boolean" }, { - "description": "the max number of Guest VMs per host for this hypervisor.", + "description": "set true to enable storage motion support for this hypervisor", "length": 255, - "name": "maxguestslimit", + "name": "storagemotionenabled", "required": false, - "type": "long" + "since": "4.16.0", + "type": "boolean" } ], "related": "listHypervisorCapabilities", "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, {}, - { - "description": "the maximum number of Hosts per cluster for this hypervisor", - "name": "maxhostspercluster", - "type": "integer" - }, { "description": "true if storage motion is supported", "name": "storagemotionenabled", "type": "boolean" }, + { + "description": "the ID of the hypervisor capabilities row", + "name": "id", + "type": "string" + }, { "description": "true if VM snapshots are enabled for this hypervisor", "name": "vmsnapshotenabled", "type": "boolean" }, { - "description": "the hypervisor type", - "name": "hypervisor", - "type": "string" + "description": "the maximum number of Hosts per cluster for this hypervisor", + "name": "maxhostspercluster", + "type": "integer" }, { - "description": "the ID of the hypervisor capabilities row", - "name": "id", + "description": "the hypervisor version", + "name": "hypervisorversion", "type": "string" }, - {}, { - "description": "the hypervisor version", - "name": "hypervisorversion", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -23548,11 +23714,6 @@ "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", @@ -23562,7 +23723,18 @@ "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "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" + }, + {} ], "since": "3.0.0" }, @@ -23571,14 +23743,6 @@ "isasync": false, "name": "findHostsForMigration", "params": [ - { - "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", - "required": true, - "type": "uuid" - }, { "description": "", "length": 255, @@ -23586,6 +23750,14 @@ "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": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,createVMFromBackup,createVMFromBackup,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", + "required": true, + "type": "uuid" + }, { "description": "List by keyword", "length": 255, @@ -23603,22 +23775,62 @@ ], "related": "", "response": [ + { + "description": "the cluster ID of the host", + "name": "clusterid", + "type": "string" + }, + { + "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 amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", + "type": "string" + }, + { + "description": "the hypervisor version", + "name": "hypervisorversion", + "type": "string" + }, + { + "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", + "name": "hasenoughcapacity", + "type": "boolean" + }, + { + "description": "the admin that annotated this host", + "name": "username", + "type": "string" + }, { "description": "GPU cards present in the host", "name": "gpugroup", "response": [ + { + "description": "GPU cards present in the host", + "name": "gpugroupname", + "type": "string" + }, { "description": "the list of enabled vGPUs", "name": "vgpu", "response": [ { - "description": "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", + "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", + "name": "maxcapacity", "type": "long" }, { @@ -23627,8 +23839,8 @@ "type": "long" }, { - "description": "Video RAM for this vGPU type", - "name": "videoram", + "description": "Maximum no. of vgpu per gpu card (pgpu)", + "name": "maxvgpuperpgpu", "type": "long" }, { @@ -23637,85 +23849,50 @@ "type": "long" }, { - "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", - "name": "maxcapacity", + "description": "Maximum Y resolution per display", + "name": "maxresolutiony", "type": "long" }, { - "description": "Model Name of vGPU", - "name": "vgputype", - "type": "string" + "description": "Video RAM for this vGPU type", + "name": "videoram", + "type": "long" }, { - "description": "Maximum Y resolution per display", - "name": "maxresolutiony", + "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", + "name": "remainingcapacity", "type": "long" } ], "type": "list" - }, - { - "description": "GPU cards present in the host", - "name": "gpugroupname", - "type": "string" } ], "type": "list" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" - }, - { - "description": "comma-separated list of tags for the host", - "name": "hosttags", + "description": "the last annotation set on this host by an admin", + "name": "annotation", "type": "string" }, { - "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", - "name": "hasenoughcapacity", - "type": "boolean" - }, - { - "description": "the state of the host", - "name": "state", - "type": "status" - }, - { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "CPU Arch of the host", - "name": "arch", + "description": "the Pod ID of the host", + "name": "podid", "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 host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" - }, - { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "the cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" - }, - { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", - "type": "long" + "description": "the ID of the host", + "name": "id", + "type": "string" }, { "description": "true if migrating a vm to this host requires storage motion, false otherwise", @@ -23723,29 +23900,34 @@ "type": "boolean" }, { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", + "description": "the host type", + "name": "type", + "type": "type" + }, + { + "description": "The ID of extension for this cluster", + "name": "extensionid", "type": "string" }, { - "description": "the name of the host", - "name": "name", + "description": "comma-separated list of storage access groups on the cluster", + "name": "clusterstorageaccessgroups", "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 date and time the host was last pinged", - "name": "lastpinged", + "description": "true if the host is disconnected. False otherwise.", + "name": "disconnected", "type": "date" }, { - "description": "the ID of the host", - "name": "id", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { "description": "the CPU speed of the host", @@ -23753,134 +23935,154 @@ "type": "long" }, { - "description": "the amount of the host's memory currently used", - "name": "memoryused", - "type": "long" + "description": "the OS category name of the host", + "name": "oscategoryname", + "type": "string" }, { - "description": "the host HA information information", - "name": "hostha", - "type": "hostharesponse" + "description": "the CPU number of the host", + "name": "cpunumber", + "type": "integer" }, { - "description": "the hypervisor version", - "name": "hypervisorversion", - "type": "string" + "description": "Total GPUs on the Host", + "name": "gputotal", + "type": "long" }, { - "description": "the OS category ID of the host", - "name": "oscategoryid", + "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 amount of the host's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the resource state of the host", - "name": "resourcestate", - "type": "string" + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" }, { - "description": "the number of CPU sockets on the host", - "name": "cpusockets", - "type": "integer" + "description": "the state of the host", + "name": "state", + "type": "status" }, { - "description": "comma-separated list of implicit host tags for the host", - "name": "implicithosttags", + "description": "true if the host supports encryption", + "name": "encryptionsupported", + "type": "boolean" + }, + { + "description": "the Zone name of the host", + "name": "zonename", "type": "string" }, { - "description": "the OS category name of the host", - "name": "oscategoryname", + "description": "events available for the host", + "name": "events", "type": "string" }, { - "description": "comma-separated list of explicit host tags for the host", - "name": "explicithosttags", + "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 outgoing network traffic on the host", + "name": "networkkbswrite", + "type": "long" + }, + { + "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", + "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": "comma-separated list of tags for the host", + "name": "hosttags", "type": "string" }, { - "description": "the last annotation set on this host by an admin", - "name": "annotation", + "description": "the Pod name of the host", + "name": "podname", "type": "string" }, { - "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 ID of extension for this cluster", - "name": "extensionid", - "type": "string" + "description": "the date and time the host was last pinged", + "name": "lastpinged", + "type": "date" }, { - "description": "capabilities of the host", - "name": "capabilities", + "description": "comma-separated list of storage access groups on the zone", + "name": "zonestorageaccessgroups", "type": "string" }, { - "description": "the cluster ID of the host", - "name": "clusterid", - "type": "string" + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" }, { - "description": "comma-separated list of storage access groups on the pod", - "name": "podstorageaccessgroups", + "description": "the cluster type of the cluster that host belongs to", + "name": "clustertype", "type": "string" }, { - "description": "the host hypervisor", - "name": "hypervisor", + "description": "the cluster name of the host", + "name": "clustername", "type": "string" }, { - "description": "the Zone name of the host", - "name": "zonename", - "type": "string" + "description": "true if the host supports instance conversion (using virt-v2v)", + "name": "instanceconversionsupported", + "type": "boolean" }, { - "description": "the host version", - "name": "version", + "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", "type": "string" }, { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", + "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", + "name": "hahost", "type": "boolean" }, { - "description": "the 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 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": "the last time this host was annotated", - "name": "lastannotated", - "type": "date" + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", + "type": "long" }, { - "description": "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 resource state of the host", + "name": "resourcestate", + "type": "string" + }, + { + "description": "the amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", + "type": "long" }, { "description": "true if the host has capability to support UEFI boot", @@ -23888,78 +24090,76 @@ "type": "boolean" }, { - "description": "the Pod name of the host", - "name": "podname", - "type": "string" + "description": "Used GPUs on the Host", + "name": "gpuused", + "type": "long" }, { - "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", + "description": "the IP address of the host", + "name": "ipaddress", "type": "string" }, { - "description": "Host details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the last time this host was annotated", + "name": "lastannotated", + "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 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", + "description": "comma-separated list of explicit host tags for the host", + "name": "explicithosttags", "type": "string" }, { - "description": "the cluster name of the host", - "name": "clustername", + "description": "the name of the host", + "name": "name", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the virtual machine id for host type ConsoleProxy and SecondaryStorageVM", + "name": "virtualmachineid", + "type": "string" }, { - "description": "the amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", + "description": "the incoming network traffic on the host", + "name": "networkkbsread", "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 OS category ID of the host", + "name": "oscategoryid", "type": "string" }, { - "description": "the host type", - "name": "type", - "type": "type" + "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "name": "memorytotal", + "type": "long" }, { - "description": "the IP address of the host", - "name": "ipaddress", - "type": "string" + "description": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", + "type": "boolean" }, { - "description": "the admin that annotated this host", - "name": "username", + "description": "comma-separated list of storage access groups on the pod", + "name": "podstorageaccessgroups", "type": "string" }, + {}, + {}, { - "description": "the Pod ID of the host", - "name": "podid", + "description": "CPU Arch of the host", + "name": "arch", "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" }, { @@ -23968,87 +24168,59 @@ "type": "date" }, { - "description": "comma-separated list of storage access groups for the host", - "name": "storageaccessgroups", + "description": "the Zone ID of the host", + "name": "zoneid", "type": "string" }, { - "description": "events available for the host", - "name": "events", + "description": "the host version", + "name": "version", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", - "type": "string" + "description": "Host details in key/value pairs.", + "name": "details", + "type": "map" }, - {}, { - "description": "comma-separated list of storage access groups on the zone", - "name": "zonestorageaccessgroups", + "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 allocated in MHz", - "name": "cpuallocatedvalue", - "type": "long" - }, - { - "description": "true if the host supports instance conversion (using virt-v2v)", - "name": "instanceconversionsupported", - "type": "boolean" - }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the host hypervisor", + "name": "hypervisor", "type": "string" }, { - "description": "Total GPUs on the Host", - "name": "gputotal", + "description": "the amount of the host's memory currently used", + "name": "memoryused", "type": "long" }, { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", + "description": "comma-separated list of implicit host tags for the host", + "name": "implicithosttags", "type": "string" }, { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", + "description": "capabilities of the host", + "name": "capabilities", "type": "string" }, { - "description": "true if the host supports encryption", - "name": "encryptionsupported", - "type": "boolean" - }, - { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", - "type": "long" - }, - { - "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", - "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": "The name of extension for this cluster", + "name": "extensionname", "type": "string" }, { - "description": "the management server name of the host", - "name": "managementservername", + "description": "comma-separated list of storage access groups for the host", + "name": "storageaccessgroups", "type": "string" - }, - { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", - "type": "boolean" } ] }, @@ -24069,29 +24241,29 @@ "related": "listCiscoNexusVSMs,disableCiscoNexusVSM", "response": [ { - "description": "device state", + "description": "The Device State (Enabled/Disabled) of the VSM", "name": "vsmdevicestate", "type": "string" }, { - "description": "storage vlan id of the VSM", - "name": "vsmstoragevlanid", - "type": "int" + "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", + "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "storage vlan id of the VSM", + "name": "vsmstoragevlanid", + "type": "int" }, { - "description": "device name", - "name": "vsmdevicename", + "description": "The Config State (Primary/Standby) of the VSM", + "name": "vsmconfigstate", "type": "string" }, { @@ -24110,35 +24282,35 @@ "type": "string" }, { - "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 VSM is a switch supervisor. This is the VSM's switch domain id", - "name": "vsmdomainid", + "description": "management vlan id of the VSM", + "name": "vsmmgmtvlanid", "type": "string" }, { - "description": "management vlan id of the VSM", - "name": "vsmmgmtvlanid", + "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": "device name", + "name": "vsmdevicename", + "type": "string" }, { - "description": "The Device State (Enabled/Disabled) of the VSM", + "description": "device state", "name": "vsmdevicestate", "type": "string" }, - {}, { - "description": "device id of the Cisco N1KV VSM device", - "name": "vsmdeviceid", - "type": "string" + "description": "control vlan id of the VSM", + "name": "vsmctrlvlanid", + "type": "int" } ] }, @@ -24164,16 +24336,16 @@ "name": "jobid", "type": "string" }, + { + "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" - }, - { - "description": "is domain admin allowed to create offerings with tags", - "name": "isallowed", - "type": "boolean" } ] }, @@ -24183,27 +24355,34 @@ "name": "addNicToVirtualMachine", "params": [ { - "description": "Virtual Machine ID", + "description": "Mac Address for the new network", "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": "macaddress", + "required": false, + "type": "string" + }, + { + "description": "Network ID", + "length": 255, + "name": "networkid", + "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": true, "type": "uuid" }, { - "description": "Network ID", + "description": "Virtual Machine ID", "length": 255, - "name": "networkid", - "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "virtualmachineid", + "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,createVMFromBackup,createVMFromBackup,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", "required": true, "type": "uuid" }, { - "description": "Mac Address for the new network", + "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": "macaddress", + "name": "dhcpoptions", "required": false, - "type": "string" + "type": "map" }, { "description": "IP Address for the new network", @@ -24211,20 +24390,43 @@ "name": "ipaddress", "required": false, "type": "string" - }, - { - "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": "dhcpoptions", - "required": false, - "type": "map" } ], - "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,createVMFromBackup,createVMFromBackup,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", "response": [ { - "description": "Vm details in key/value pairs.", - "name": "details", + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", + "type": "string" + }, + { + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" + }, + { + "description": "User VM type", + "name": "vmtype", + "type": "string" + }, + { + "description": "the account associated with the virtual machine", + "name": "account", + "type": "string" + }, + { + "description": "the format of the template for the virtual machine", + "name": "templateformat", + "type": "string" + }, + { + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" + }, + { + "description": "VNF details", + "name": "vnfdetails", "type": "map" }, { @@ -24233,116 +24435,482 @@ "type": "integer" }, { - "description": "the maximum X resolution", - "name": "maxresolutionx", + "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", + "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": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" + }, + { + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", "type": "long" }, + { + "description": "the project id of the vm", + "name": "projectid", + "type": "string" + }, { "description": "path of the domain in which the virtual machine exists", "name": "domainpath", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", + "description": "CPU arch of the VM", + "name": "arch", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" + }, + { + "description": "Guest vm Boot Type", + "name": "boottype", + "type": "string" + }, + { + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, + { + "description": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" + }, + { + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", "response": [ { - "description": "the account associated with the tag", - "name": "account", + "description": "the project id of the group", + "name": "projectid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the ID of the security group", + "name": "id", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the domain ID of the security group", + "name": "domainid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the account owning the security group", + "name": "account", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "path of the Domain the security group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", - "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 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": "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 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": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project 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": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + } + ], + "type": "set" + } + ], + "type": "set" }, { - "description": "the project id the tag belongs to", - "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 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": "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": "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": "the account associated with the tag", + "name": "account", + "type": "string" + } + ], + "type": "set" }, { - "description": "tag value", - "name": "value", + "description": "the project name of the group", + "name": "project", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the name of the security group", + "name": "name", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the domain name of the security group", + "name": "domain", "type": "string" }, { - "description": "tag key name", - "name": "key", + "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 list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "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 project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "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 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" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "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 number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" } ], "type": "set" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "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": "the count of GPUs on the virtual machine", + "name": "gpucount", + "type": "integer" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "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 vGPU type used by the virtual machine", + "name": "vgpu", "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 total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { "description": "list of variables and values for the variables declared in userdata", @@ -24350,635 +24918,494 @@ "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": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "the project name of the vm", - "name": "project", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "the name of the gpu card to which service offering is linked", - "name": "gpucardname", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "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": "the video RAM size in MB", - "name": "videoram", - "type": "long" + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", + "type": "string" }, { - "description": "Instance lease expiry action", - "name": "leaseexpiryaction", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" + "description": "Instance lease duration in days", + "name": "leaseduration", + "type": "integer" }, { - "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": "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": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" + "description": "the maximum X resolution", + "name": "maxresolutionx", + "type": "long" }, { - "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 date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" - }, - { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "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", - "type": "integer" - }, - { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "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": "path of the Domain the affinity group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the domain ID of the affinity group", + "name": "domainid", "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 cidr of IPv6 network", - "name": "ip6cidr", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "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": "the type of the affinity group", + "name": "type", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", "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 name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "the project ID of the affinity group", + "name": "projectid", "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": "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", - "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "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 account owning the affinity group", + "name": "account", "type": "string" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" } ], "type": "set" }, + { + "description": "the maximum Y resolution", + "name": "maxresolutiony", + "type": "long" + }, { "description": "NICs of the VNF appliance", "name": "vnfnics", "type": "list" }, { - "description": "User VM type", - "name": "vmtype", - "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", + "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 virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, - { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" - }, { "description": "the control state of the host for the virtual machine", "name": "hostcontrolstate", "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "the format of the template for the virtual machine", - "name": "templateformat", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, + {}, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", + "description": "the read (IO) of disk on the VM", + "name": "diskioread", "type": "long" }, - {}, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" + "description": "the user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "State of the Service from LB rule", + "name": "servicestate", "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 ID of the gpu card to which service offering is linked", - "name": "gpucardid", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" + "description": "the maximum number of display heads", + "name": "maxheads", + "type": "long" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" + "description": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" }, { - "description": "CPU arch of the VM", - "name": "arch", - "type": "string" + "description": "the video RAM size in MB", + "name": "videoram", + "type": "long" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", - "type": "string" + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "the ID of the virtual machine", + "name": "id", + "type": "string" }, - {}, { - "description": "Guest vm Boot Type", - "name": "boottype", + "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 gpu card to which service offering is linked", + "name": "gpucardname", "type": "string" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", + "description": "the list of nics associated with vm", + "name": "nic", "response": [ { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "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": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "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 domain name of the affinity group", - "name": "domain", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "the ID of the affinity group", - "name": "id", + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the account owning the affinity group", - "name": "account", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", "type": "list" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the type of the affinity group", + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "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 description of the affinity group", - "name": "description", + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", - "type": "string" + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" } ], "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 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", + "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 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", + "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", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, + {}, { "description": "the 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", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "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", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { @@ -24987,395 +25414,140 @@ "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 target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "the 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", + "type": "string" }, { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", + "description": "the list of resource tags associated", + "name": "tags", "response": [ { - "description": "the ID of the security group", - "name": "id", - "type": "string" - }, - { - "description": "the name of the security group", - "name": "name", + "description": "id of the resource", + "name": "resourceid", "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 account owning the security group", + "description": "the account associated with the tag", "name": "account", "type": "string" }, { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", - "response": [ - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the 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": "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 account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the 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": "account owning the security group rule", - "name": "account", - "type": "string" - } - ], - "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": "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", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "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": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "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": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - } - ], - "type": "set" + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" }, { - "description": "the domain name of the security group", - "name": "domain", + "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": "path of the Domain the security group belongs to", + "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 id of the group", - "name": "projectid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the project name of the group", - "name": "project", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - } - ], - "type": "set" + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" }, { - "description": "the description of the security group", - "name": "description", + "description": "tag value", + "name": "value", "type": "string" } ], "type": "set" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "the 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 password (if exists) of the virtual machine", - "name": "password", + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "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 VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "the pool type of the virtual machine", + "name": "pooltype", + "type": "string" + }, + { + "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", + "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 primary IP address", + "name": "ipaddress", "type": "string" } ] @@ -25386,116 +25558,168 @@ "name": "listStaticRoutes", "params": [ { - "description": "List resources by tags (key/value pairs)", + "description": "list static route by id", "length": 255, - "name": "tags", + "name": "id", + "related": "listStaticRoutes", "required": false, - "type": "map" + "type": "uuid" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "list static routes by state", "length": 255, - "name": "account", + "name": "state", "required": false, "type": "string" }, { - "description": "list static routes by vpc id", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "name": "isrecursive", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "List by keyword", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "keyword", + "name": "tags", "required": false, - "type": "string" + "type": "map" }, { - "description": "", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources 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 objects by project; if projectid=-1 lists All VMs", + "description": "", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "pagesize", "required": false, - "type": "uuid" + "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": "", "length": 255, - "name": "listall", + "name": "page", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "list static routes by gateway id", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "gatewayid", - "related": "createPrivateGateway,createPrivateGateway,listPrivateGateways", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, "type": "uuid" }, { - "description": "list static route by id", + "description": "list static routes by vpc id", "length": 255, - "name": "id", - "related": "listStaticRoutes", + "name": "vpcid", + "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", "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": "list static routes by state", + "description": "List by keyword", "length": 255, - "name": "state", + "name": "keyword", "required": false, "type": "string" }, { - "description": "", + "description": "list static routes by gateway id", "length": 255, - "name": "pagesize", + "name": "gatewayid", + "related": "createPrivateGateway,createPrivateGateway,listPrivateGateways", "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 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" } ], "related": "", "response": [ + { + "description": "the account associated with the static route", + "name": "account", + "type": "string" + }, + { + "description": "the domain path associated with the static route", + "name": "domainpath", + "type": "string" + }, + { + "description": "the state of the static route", + "name": "state", + "type": "string" + }, + { + "description": "the project id of the static route", + "name": "projectid", + "type": "string" + }, + { + "description": "VPC the static route belongs to", + "name": "vpcid", + "type": "string" + }, + { + "description": "IP of VPC gateway the route is created for", + "name": "vpcgatewayip", + "type": "string" + }, + {}, + {}, + { + "description": "the ID of static route", + "name": "id", + "type": "string" + }, + { + "description": "the domain associated with the static route", + "name": "domain", + "type": "string" + }, + { + "description": "VPC gateway the route is created for", + "name": "vpcgatewayid", + "type": "string" + }, + { + "description": "the project name of the static route", + "name": "project", + "type": "string" + }, { "description": "the list of resource tags associated with static route", "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": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -25504,13 +25728,13 @@ "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" }, { @@ -25519,36 +25743,36 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the 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": "resource type", - "name": "resourcetype", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" } ], "type": "list" }, { - "description": "the account associated with the static route", - "name": "account", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -25556,68 +25780,16 @@ "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" - }, - { - "description": "the state of the static route", - "name": "state", - "type": "string" - }, - {}, - { - "description": "the ID of static route", - "name": "id", - "type": "string" - }, { "description": "the ID of the domain associated with the static route", "name": "domainid", "type": "string" }, - { - "description": "the domain associated with the static route", - "name": "domain", - "type": "string" - }, - { - "description": "the project id of the static route", - "name": "projectid", - "type": "string" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -25631,27 +25803,18 @@ "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", - "type": "boolean" - }, - { - "description": "lists the specified IP address", + "description": "lists all public IP addresses by state", "length": 255, - "name": "ipaddress", + "name": "state", "required": false, "type": "string" }, { - "description": "true if range is dedicated for external network provider", + "description": "List by keyword", "length": 255, - "name": "forprovider", + "name": "keyword", "required": false, - "since": "4.21.0", - "type": "boolean" + "type": "string" }, { "description": "lists all public IP addresses by physical network ID", @@ -25662,77 +25825,75 @@ "type": "uuid" }, { - "description": "lists all public IP addresses by zone ID", + "description": "lists IP address by ID", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "id", + "related": "associateIpAddress,reserveIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", "required": false, "type": "uuid" }, { - "description": "List resources by tags (key/value pairs)", + "description": "List IPs belonging to the VPC", "length": 255, - "name": "tags", + "name": "vpcid", + "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", "required": false, - "type": "map" + "type": "uuid" }, { - "description": "list only static NAT IP addresses", + "description": "list only source NAT IP addresses", "length": 255, - "name": "isstaticnat", + "name": "issourcenat", "required": false, "type": "boolean" }, { - "description": "lists IP address by ID", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "id", - "related": "associateIpAddress,reserveIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, "type": "uuid" }, { - "description": "list only IPs used for load balancing", + "description": "true if range is dedicated for external network provider", "length": 255, - "name": "forloadbalancing", + "name": "forprovider", "required": false, + "since": "4.21.0", "type": "boolean" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, - { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "lists all public IP addresses by source network ID", "length": 255, - "name": "listall", + "name": "networkid", + "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, - "type": "boolean" + "since": "4.13.0", + "type": "uuid" }, { - "description": "list only source NAT IP addresses", + "description": "true if range is dedicated for system VMs", "length": 255, - "name": "issourcenat", + "name": "forsystemvms", "required": false, + "since": "4.20.0", "type": "boolean" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "lists all public IP addresses associated to the network specified", "length": 255, - "name": "account", + "name": "associatednetworkid", + "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "lists all public IP addresses by source network ID", + "description": "lists all public IP addresses by VLAN ID", "length": 255, - "name": "networkid", - "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "vlanid", + "related": "createVlanIpRange,updateVlanIpRange,listVlanIpRanges,dedicatePublicIpRange", "required": false, - "since": "4.13.0", "type": "uuid" }, { @@ -25743,35 +25904,56 @@ "type": "boolean" }, { - "description": "limits search results to allocated public IP addresses", + "description": "the virtual network for the IP address", "length": 255, - "name": "allocatedonly", + "name": "forvirtualnetwork", "required": false, "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": "string" + }, + { + "description": "list only static NAT IP addresses", + "length": 255, + "name": "isstaticnat", "required": false, "type": "boolean" }, { - "description": "list only resources belonging to the domain specified", + "description": "lists all public IP addresses by zone ID", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "uuid" }, { - "description": "lists all public IP addresses by VLAN ID", + "description": "lists the specified IP address", "length": 255, - "name": "vlanid", - "related": "createVlanIpRange,updateVlanIpRange,listVlanIpRanges,dedicatePublicIpRange", + "name": "ipaddress", + "required": false, + "type": "string" + }, + { + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, "type": "uuid" }, + { + "description": "list only IPs used for load balancing", + "length": 255, + "name": "forloadbalancing", + "required": false, + "type": "boolean" + }, { "description": "", "length": 255, @@ -25780,216 +25962,238 @@ "type": "integer" }, { - "description": "the virtual network for the IP address", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "forvirtualnetwork", + "name": "isrecursive", "required": false, "type": "boolean" }, { - "description": "", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "page", + "name": "listall", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "tags", "required": false, - "type": "uuid" + "type": "map" }, { - "description": "lists all public IP addresses associated to the network specified", + "description": "", "length": 255, - "name": "associatednetworkid", - "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "List IPs belonging to the VPC", + "description": "limits search results to allocated public IP addresses", "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "name": "allocatedonly", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "true if range is dedicated for system VMs", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "forsystemvms", + "name": "fordisplay", "required": false, - "since": "4.20.0", + "since": "4.4", + "type": "boolean" + } + ], + "related": "associateIpAddress,reserveIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "response": [ + { + "description": "true if this ip is system ip (was allocated as a part of deployVm or createLbRule)", + "name": "issystem", + "type": "boolean" + }, + { + "description": "virtual machine id the ip address is assigned to", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "whether the ip address has Firewall/PortForwarding/LoadBalancing rules defined", + "name": "hasrules", + "type": "boolean" + }, + {}, + { + "description": "VPC name the ip belongs to", + "name": "vpcname", + "type": "string" + }, + { + "description": "State of the ip address. Can be: Allocating, Allocated, Releasing, Reserved and Free", + "name": "state", + "type": "string" + }, + { + "description": "public IP address id", + "name": "id", + "type": "string" + }, + {}, + { + "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", + "type": "string" + }, + { + "description": "the project id of the ipaddress", + "name": "projectid", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "lists all public IP addresses by state", - "length": 255, - "name": "state", - "required": false, + "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", "type": "string" - } - ], - "related": "associateIpAddress,reserveIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", - "response": [ + }, { - "description": "is public IP portable across the zones", - "name": "isportable", - "type": "boolean" + "description": "purpose of the IP address. In Acton this value is not null for Ips with isSystem=true, and can have either StaticNat or LB value", + "name": "purpose", + "type": "string" }, { - "description": "the VLAN associated with the IP address", - "name": "vlanname", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "VPC name the ip belongs to", - "name": "vpcname", + "description": "the name of the zone the public IP address belongs to", + "name": "zonename", "type": "string" }, { - "description": "VPC id the ip belongs to", - "name": "vpcid", + "description": "the name of the Network where ip belongs to", + "name": "networkname", "type": "string" }, { - "description": "true if this ip is system ip (was allocated as a part of deployVm or createLbRule)", - "name": "issystem", - "type": "boolean" + "description": "date the public IP address was acquired", + "name": "allocated", + "type": "date" }, { - "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": "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 Network where ip belongs to", + "name": "networkid", "type": "string" }, + { + "description": "true if the IP address is a source nat address, false otherwise", + "name": "issourcenat", + "type": "boolean" + }, { "description": "the list of resource tags associated with ip address", "name": "tags", "response": [ { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "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" }, { - "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": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "id of the resource", + "name": "resourceid", "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": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "path of the domain to which the public IP address belongs", - "name": "domainpath", + "description": "virtual machine name the ip address is assigned to", + "name": "virtualmachinename", "type": "string" }, { - "description": "virtual machine type the ip address is assigned to", - "name": "virtualmachinetype", + "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 name of the Network where ip belongs to", - "name": "networkname", + "description": "public IP address", + "name": "ipaddress", "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" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" - }, - { - "description": "the account the public IP address is associated with", - "name": "account", - "type": "string" - }, - { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the ID of the VLAN associated with the IP address. This parameter is visible to ROOT admins only", + "name": "vlanid", "type": "string" }, { @@ -25998,24 +26202,18 @@ "type": "string" }, { - "description": "the virtual network for the IP address", - "name": "forvirtualnetwork", + "description": "true if this ip is for static nat, false otherwise", + "name": "isstaticnat", "type": "boolean" }, { - "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": "virtual machine name the ip address is assigned to", - "name": "virtualmachinename", + "description": "path of the domain to which the public IP address belongs", + "name": "domainpath", "type": "string" }, { @@ -26024,76 +26222,50 @@ "type": "string" }, { - "description": "whether the ip address has Firewall/PortForwarding/LoadBalancing rules defined", - "name": "hasrules", + "description": "is public ip for display to the regular user", + "name": "fordisplay", "type": "boolean" }, { - "description": "date the public IP address was acquired", - "name": "allocated", - "type": "date" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "public IP address id", - "name": "id", + "description": "the name of the Network associated with the IP address", + "name": "associatednetworkname", "type": "string" }, { - "description": "virtual machine display name the ip address is assigned to (not null only for static nat Ip)", - "name": "virtualmachinedisplayname", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "true if range is dedicated for external network providers", - "name": "forprovider", + "description": "the virtual network for the IP address", + "name": "forvirtualnetwork", "type": "boolean" }, { - "description": "the ID of the zone the public IP address belongs to", - "name": "zoneid", - "type": "string" - }, - { - "description": "the domain ID the public IP address is associated with", - "name": "domainid", - "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 (dnat) ip address (not null only for static nat Ip)", + "name": "vmipaddress", "type": "string" }, { - "description": "true if this ip is for static nat, false otherwise", - "name": "isstaticnat", + "description": "true if range is dedicated for System VMs", + "name": "forsystemvms", "type": "boolean" }, { - "description": "virtual machine id the ip address is assigned to", - "name": "virtualmachineid", + "description": "the account the public IP address is associated with", + "name": "account", "type": "string" }, { - "description": "true if the IP address is a source nat address, false otherwise", - "name": "issourcenat", - "type": "boolean" - }, - { - "description": "public IP address", - "name": "ipaddress", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the project name of the address", - "name": "project", + "description": "the ID of the zone the public IP address belongs to", + "name": "zoneid", "type": "string" - }, - {} + } ] }, { @@ -26102,27 +26274,28 @@ "name": "listOpenDaylightControllers", "params": [ { - "description": "the Physical Network ID", + "description": "the ID of a OpenDaylight Controller", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", + "name": "id", + "related": "addOpenDaylightController,deleteOpenDaylightController,listOpenDaylightControllers", "required": false, "type": "uuid" }, { - "description": "the ID of a OpenDaylight Controller", + "description": "the Physical Network ID", "length": 255, - "name": "id", - "related": "addOpenDaylightController,deleteOpenDaylightController,listOpenDaylightControllers", + "name": "physicalnetworkid", + "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", "required": false, "type": "uuid" } ], "related": "addOpenDaylightController,deleteOpenDaylightController", "response": [ + {}, { - "description": "the physical network to which this controller belongs to", - "name": "physicalnetworkid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -26130,33 +26303,32 @@ "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 url of the controller api", - "name": "url", + "description": "the physical network to which this controller belongs to", + "name": "physicalnetworkid", "type": "string" }, + {}, { "description": "the username to authenticate to the controller", "name": "username", "type": "string" }, - {}, { "description": "device id of the controller", "name": "id", "type": "string" }, - {} + { + "description": "the url of the controller api", + "name": "url", + "type": "string" + } ] }, { @@ -26165,9 +26337,17 @@ "name": "addBigSwitchBcfDevice", "params": [ { - "description": "Hostname of ip address of the BigSwitch BCF Controller.", + "description": "the Physical Network ID", "length": 255, - "name": "hostname", + "name": "physicalnetworkid", + "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", + "required": true, + "type": "uuid" + }, + { + "description": "Username of the BigSwitch BCF Controller.", + "length": 255, + "name": "username", "required": true, "type": "string" }, @@ -26179,20 +26359,12 @@ "type": "boolean" }, { - "description": "Username of the BigSwitch BCF Controller.", + "description": "Hostname of ip address of the BigSwitch BCF Controller.", "length": 255, - "name": "username", + "name": "hostname", "required": true, "type": "string" }, - { - "description": "the Physical Network ID", - "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", - "required": true, - "type": "uuid" - }, { "description": "Password of the BigSwitch BCF Controller.", "length": 255, @@ -26209,50 +26381,50 @@ "type": "string" }, { - "description": "the physical network to which this BigSwitch BCF segment belongs to", - "name": "physicalnetworkid", + "description": "the controller Ip address", + "name": "hostname", + "type": "string" + }, + { + "description": "the controller password", + "name": "password", "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - { - "description": "name of the provider", - "name": "provider", - "type": "string" - }, { "description": "NAT support", "name": "nat", "type": "boolean" }, { - "description": "the controller Ip address", - "name": "hostname", + "description": "name of the provider", + "name": "provider", "type": "string" }, + {}, { - "description": "device name", - "name": "bigswitchdevicename", + "description": "the controller username", + "name": "username", "type": "string" }, { - "description": "the controller password", - "name": "password", + "description": "the physical network to which this BigSwitch BCF segment belongs to", + "name": "physicalnetworkid", "type": "string" }, - {}, { - "description": "the controller username", - "name": "username", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "device name", + "name": "bigswitchdevicename", "type": "string" } ], @@ -26264,183 +26436,275 @@ "name": "updateDefaultNicForVirtualMachine", "params": [ { - "description": "NIC ID", + "description": "Virtual Machine ID", "length": 255, - "name": "nicid", - "related": "listNics", + "name": "virtualmachineid", + "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,createVMFromBackup,createVMFromBackup,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", "required": true, "type": "uuid" }, { - "description": "Virtual Machine ID", + "description": "NIC ID", "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", + "name": "nicid", + "related": "listNics", "required": true, "type": "uuid" } ], - "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": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,createVMFromBackup,createVMFromBackup,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", "response": [ { - "description": "the count of GPUs on the virtual machine", - "name": "gpucount", - "type": "integer" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "the maximum number of display heads", - "name": "maxheads", - "type": "long" + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", + "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "the ID of the service offering of the 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 number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, { - "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 name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "the maximum Y resolution", - "name": "maxresolutiony", + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "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", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "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 name of the security group", + "description": "the domain name of the affinity group", "name": "domain", "type": "string" }, { - "description": "the description of the security group", + "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 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 type of the affinity group", + "name": "type", + "type": "string" }, { - "description": "the ID of the security group", + "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 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 ID of the affinity group", "name": "id", "type": "string" + } + ], + "type": "set" + }, + { + "description": "the ID of the host for the virtual machine", + "name": "hostid", + "type": "string" + }, + { + "description": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" + }, + { + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" }, { - "description": "the project name of the group", + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "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": "tag value", + "name": "value", + "type": "string" }, { - "description": "the name of the security group", - "name": "name", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the account owning the security group", + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the account associated with the tag", "name": "account", "type": "string" }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + } + ], + "type": "set" + }, + { + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" + }, + { + "description": "the name of the host for the virtual machine", + "name": "hostname", + "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 domain ID of the security group", "name": "domainid", "type": "string" }, { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "the 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 owning the security group", + "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", @@ -26452,38 +26716,38 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -26492,32 +26756,27 @@ "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 ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], "type": "set" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", + "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 protocol of the security group rule", @@ -26525,8 +26784,8 @@ "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" }, { @@ -26535,45 +26794,45 @@ "type": "integer" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", + "description": "the starting IP of the security group rule", + "name": "startport", "type": "integer" }, { - "description": "security group name", - "name": "securitygroupname", - "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 id of the security group rule", + "name": "ruleid", + "type": "string" } ], "type": "set" }, { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", "response": [ + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, { "description": "security group name", "name": "securitygroupname", "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" }, { @@ -26582,42 +26841,27 @@ "type": "string" }, { - "description": "account owning the security group rule", - "name": "account", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, - { - "description": "the 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", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -26626,8 +26870,8 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -26636,42 +26880,129 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag value", + "name": "value", "type": "string" }, { "description": "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" } ], "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 id of the security group rule", "name": "ruleid", "type": "string" }, { - "description": "the starting IP of the security group rule", - "name": "startport", + "description": "the code for the ICMP message response", + "name": "icmpcode", "type": "integer" + } + ], + "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 project name of the group", + "name": "project", + "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 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": "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 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": "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" } ], "type": "set" @@ -26680,481 +27011,369 @@ "type": "set" }, { - "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": "the name of the gpu card to which service offering is linked", - "name": "gpucardname", - "type": "string" - }, - {}, - { - "description": "OS name of the vm", - "name": "osdisplayname", - "type": "string" + "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", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", + "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", + "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", + "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": "User VM type", + "name": "vmtype", "type": "string" }, { - "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": "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": "the total number of network traffic bytes sent", - "name": "sentbytes", + "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": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "OS name of the vm", + "name": "osdisplayname", "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 name of the virtual machine", + "name": "name", "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" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, { - "description": "Instance lease expiry action", - "name": "leaseexpiryaction", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, + {}, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "description": "User VM type", - "name": "vmtype", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "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": "true if high-availability is enabled, false otherwise", - "name": "haenable", + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", "type": "boolean" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "Instance lease expiry date", - "name": "leaseexpirydate", + "description": "the date when this virtual machine was created", + "name": "created", "type": "date" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" - }, - { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", + "description": "the maximum X resolution", + "name": "maxresolutionx", "type": "long" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", - "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", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "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 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", + "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": "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 ID of the virtual machine", - "name": "id", + "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", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "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": "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", + "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": "publicip", + "description": "the format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", + "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "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", + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", "type": "long" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", - "type": "string" + "description": "the maximum number of display heads", + "name": "maxheads", + "type": "long" }, { - "description": "CPU arch of the VM", - "name": "arch", + "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 pool type of the virtual machine", - "name": "pooltype", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, - {}, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", "type": "string" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", + "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 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 availability zone for the virtual machine", - "name": "zoneid", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", "type": "long" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "the 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": "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 amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", + "type": "string" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "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": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", - "type": "string" + "description": "the video RAM size in MB", + "name": "videoram", + "type": "long" }, { "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", + "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": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" }, { - "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" }, { @@ -27163,43 +27382,28 @@ "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", + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", "type": "list" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the isolation uri of the nic", + "name": "isolationuri", "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 ID of the corresponding network", - "name": "networkid", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { @@ -27207,74 +27411,44 @@ "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", + "name": "macaddress", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "the gateway of 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": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { "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", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { @@ -27283,134 +27457,97 @@ "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - } - ], - "type": "set" - }, - { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" - }, - { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", - "type": "string" - }, - { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" - }, - { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the project name of the affinity group", - "name": "project", + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", "type": "list" }, { - "description": "the ID of the affinity group", - "name": "id", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", - "type": "list" + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", + "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" } ], "type": "set" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "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": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "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 amount of the vm's CPU currently used", - "name": "cpuused", - "type": "string" - }, - { - "description": "the project name of the vm", - "name": "project", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { @@ -27419,263 +27556,136 @@ "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", + "description": "the VM's primary IP address", + "name": "ipaddress", "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": "Generate DRS plan for a cluster", - "isasync": false, - "name": "generateClusterDrsPlan", - "params": [ - { - "description": "the ID of the Cluster", - "length": 255, - "name": "id", - "related": "addCluster,updateCluster", - "required": true, - "type": "uuid" }, { - "description": "Maximum number of VMs to migrate for a DRS execution. Defaults to value of cluster's drs.vm.migrations setting", - "length": 255, - "name": "migrations", - "required": false, + "description": "the speed of each vCPU", + "name": "cpuspeed", "type": "integer" - } - ], - "related": "executeClusterDrsPlan", - "response": [ - {}, - { - "description": "Id of the cluster", - "name": "clusterid", - "type": "string" }, { - "description": "unique ID of the drs plan for cluster", - "name": "id", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "Type of DRS Plan (Automated or Manual))", - "name": "type", - "type": "type" - }, - { - "description": "Start event Id of the DRS Plan", - "name": "eventid", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "List of migrations", - "name": "migrations", - "type": "list" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "Status of DRS Plan", - "name": "status", - "type": "status" - }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, - {} - ], - "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": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", - "required": true, - "type": "uuid" - } - ], - "response": [ - {}, { - "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 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": "any text associated with the success or failure", - "name": "displaytext", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", + "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": "Initiates the specified power action to the host's out-of-band management interface", - "isasync": true, - "name": "issueOutOfBandManagementPowerAction", + "description": "Generate DRS plan for a cluster", + "isasync": false, + "name": "generateClusterDrsPlan", "params": [ { - "description": "out-of-band management power actions, valid actions are: ON, OFF, CYCLE, RESET, SOFT, STATUS", - "length": 255, - "name": "action", - "required": true, - "type": "string" - }, - { - "description": "optional operation timeout in seconds that overrides the global or cluster-level out-of-band management timeout setting", + "description": "Maximum number of VMs to migrate for a DRS execution. Defaults to value of cluster's drs.vm.migrations setting", "length": 255, - "name": "timeout", + "name": "migrations", "required": false, - "type": "long" + "type": "integer" }, { - "description": "the ID of the host", + "description": "the ID of the Cluster", "length": 255, - "name": "hostid", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,addBaremetalHost", + "name": "id", + "related": "addCluster,updateCluster", "required": true, "type": "uuid" } ], - "related": "enableOutOfBandManagementForHost,disableOutOfBandManagementForHost,enableOutOfBandManagementForCluster,disableOutOfBandManagementForCluster,configureOutOfBandManagement,changeOutOfBandManagementPassword", + "related": "executeClusterDrsPlan", "response": [ { - "description": "the operation result description", - "name": "description", - "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" - }, - { - "description": "the out-of-band management interface port", - "name": "port", + "description": "Start event Id of the DRS Plan", + "name": "eventid", "type": "string" }, {}, + {}, { - "description": "the operation result", + "description": "Status of DRS Plan", "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", - "type": "string" + "type": "status" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the out-of-band management interface username", - "name": "username", - "type": "string" + "description": "Type of DRS Plan (Automated or Manual))", + "name": "type", + "type": "type" }, { - "description": "the out-of-band management driver for the host", - "name": "driver", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the ID of the host", - "name": "hostid", + "description": "Id of the cluster", + "name": "clusterid", "type": "string" }, { - "description": "the out-of-band management action (if issued)", - "name": "action", + "description": "unique ID of the drs plan for cluster", + "name": "id", "type": "string" }, - {}, { - "description": "the out-of-band management interface powerState of the host", - "name": "powerstate", - "type": "powerstate" + "description": "List of migrations", + "name": "migrations", + "type": "list" } ], - "since": "4.9.0" + "since": "4.19.0" }, { "description": "Create a new Shared File System of specified size and disk offering, attached to the given network", "isasync": true, "name": "createSharedFileSystem", "params": [ - { - "description": "the project associated with the shared filesystem. Mutually exclusive with account parameter", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", - "required": false, - "type": "uuid" - }, - { - "description": "the disk offering to use for the underlying storage. This will define the size and other specifications like encryption and qos for the shared filesystem.", - "length": 255, - "name": "diskofferingid", - "related": "createDiskOffering,listDiskOfferings", - "required": true, - "type": "uuid" - }, - { - "description": "the description for the shared filesystem.", - "length": 255, - "name": "description", - "required": false, - "type": "string" - }, { "description": "network to attach the shared filesystem to", "length": 255, @@ -27685,17 +27695,10 @@ "type": "uuid" }, { - "description": "max iops", - "length": 255, - "name": "maxiops", - "required": false, - "type": "long" - }, - { - "description": "the domain ID associated with the shared filesystem. If used with the account parameter returns the shared filesystem associated with the account for the specified domain.If account is NOT provided then the shared filesystem will be assigned to the caller account and domain.", + "description": "the project associated with the shared filesystem. Mutually exclusive with account parameter", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, "type": "uuid" }, @@ -27708,23 +27711,23 @@ "type": "uuid" }, { - "description": "the name of the shared filesystem.", + "description": "the account associated with the shared filesystem. Must be used with the domainId parameter.", "length": 255, - "name": "name", - "required": true, + "name": "account", + "required": false, "type": "string" }, { - "description": "the size of the shared filesystem in GiB", + "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": "size", + "name": "provider", "required": false, - "type": "long" + "type": "string" }, { - "description": "the provider to be used for the shared filesystem. The list of providers can be fetched by using the listSharedFileSystemProviders API.", + "description": "the description for the shared filesystem.", "length": 255, - "name": "provider", + "name": "description", "required": false, "type": "string" }, @@ -27736,6 +27739,13 @@ "required": true, "type": "uuid" }, + { + "description": "max iops", + "length": 255, + "name": "maxiops", + "required": false, + "type": "long" + }, { "description": "min iops", "length": 255, @@ -27743,6 +27753,13 @@ "required": false, "type": "long" }, + { + "description": "the size of the shared filesystem in GiB", + "length": 255, + "name": "size", + "required": false, + "type": "long" + }, { "description": "the filesystem format (XFS / EXT4) which will be installed on the shared filesystem.", "length": 255, @@ -27751,120 +27768,44 @@ "type": "string" }, { - "description": "the account associated with the shared filesystem. Must be used with the domainId parameter.", + "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": "account", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, - "type": "string" - } - ], - "related": "listSharedFileSystems,startSharedFileSystem,stopSharedFileSystem,changeSharedFileSystemDiskOffering,changeSharedFileSystemServiceOffering", - "response": [ - {}, - { - "description": "Name of the availability zone", - "name": "zonename", - "type": "string" - }, - { - "description": "disk offering display text for the shared filesystem", - "name": "diskofferingdisplaytext", - "type": "string" - }, - { - "description": "ID of the storage pool hosting the data volume", - "name": "storageid", - "type": "string" + "type": "uuid" }, { - "description": "ID of the shared filesystem", - "name": "id", + "description": "the name of the shared filesystem.", + "length": 255, + "name": "name", + "required": true, "type": "string" }, { - "description": "service offering ID for the shared filesystem", - "name": "serviceofferingid", - "type": "string" - }, + "description": "the disk offering to use for the underlying storage. This will define the size and other specifications like encryption and qos for the shared filesystem.", + "length": 255, + "name": "diskofferingid", + "related": "createDiskOffering,listDiskOfferings", + "required": true, + "type": "uuid" + } + ], + "related": "listSharedFileSystems,startSharedFileSystem,stopSharedFileSystem,changeSharedFileSystemDiskOffering,changeSharedFileSystemServiceOffering", + "response": [ { "description": "the write (IO) of disk on the shared filesystem", "name": "diskiowrite", "type": "long" }, - { - "description": "description of the shared filesystem", - "name": "description", - "type": "string" - }, - { - "description": "disk offering for the shared filesystem", - "name": "diskofferingname", - "type": "string" - }, - { - "description": "ID of the storage fs data volume", - "name": "volumeid", - "type": "string" - }, - { - "description": "disk offering for the shared filesystem has custom size", - "name": "iscustomdiskoffering", - "type": "boolean" - }, { "description": "true if the entity/resource has annotations", "name": "hasannotations", "type": "boolean" }, { - "description": "disk offering ID for the shared filesystem", - "name": "diskofferingid", - "type": "string" - }, - { - "description": "the bytes allocated", - "name": "virtualsize", - "type": "long" - }, - { - "description": "the ID of the domain associated with the shared filesystem", - "name": "domainid", - "type": "string" - }, - { - "description": "the filesystem format", - "name": "filesystem", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the state of the shared filesystem", - "name": "state", - "type": "string" - }, - {}, - { - "description": "service offering for the shared filesystem", - "name": "serviceofferingname", - "type": "string" - }, - { - "description": "the disk utilization", - "name": "utilization", - "type": "string" - }, - { - "description": "ID of the storage fs vm", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "path to mount the shared filesystem", - "name": "path", + "description": "size of the shared filesystem in GiB", + "name": "sizegb", "type": "string" }, { @@ -27872,13 +27813,13 @@ "name": "tags", "response": [ { - "description": "resource type", - "name": "resourcetype", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -27887,13 +27828,13 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -27902,45 +27843,55 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "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 account associated with the tag", - "name": "account", + "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": "the project id the tag belongs to", - "name": "projectid", + "description": "tag value", + "name": "value", "type": "string" } ], "type": "set" }, + { + "description": "the filesystem format", + "name": "filesystem", + "type": "string" + }, + { + "description": "service offering for the shared filesystem", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "path of the domain to which the shared filesystem", + "name": "domainpath", + "type": "string" + }, { "description": "the list of nics associated with the shared filesystem", "name": "nic", "response": [ { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { @@ -27949,48 +27900,33 @@ "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the IPv6 address of network", + "name": "ip6address", "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 netmask of the nic", - "name": "netmask", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "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": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { @@ -27999,18 +27935,23 @@ "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "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": "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" }, { @@ -28019,9 +27960,14 @@ "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": "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", @@ -28029,13 +27975,13 @@ "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { @@ -28044,56 +27990,71 @@ "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the isolation uri of the nic", + "name": "isolationuri", "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": "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": "the ID of the nic", - "name": "id", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", "type": "integer" } ], "type": "list" }, { - "description": "the project ID of the shared filesystem", - "name": "projectid", + "description": "the shared filesystem's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "Network name of the shared filesystem", + "name": "networkname", "type": "string" }, { @@ -28101,103 +28062,314 @@ "name": "name", "type": "string" }, + { + "description": "the disk utilization", + "name": "utilization", + "type": "string" + }, + { + "description": "the ID of the domain associated with the shared filesystem", + "name": "domainid", + "type": "string" + }, + { + "description": "the shared filesystem provider", + "name": "provider", + "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": "disk offering for the shared filesystem has custom size", + "name": "iscustomdiskoffering", + "type": "boolean" + }, + { + "description": "the project name of the shared filesystem", + "name": "project", "type": "string" }, { - "description": "Network ID of the shared filesystem", - "name": "networkid", + "description": "disk offering ID for the shared filesystem", + "name": "diskofferingid", "type": "string" }, { - "description": "Network name of the shared filesystem", - "name": "networkname", + "description": "size of the shared filesystem", + "name": "size", + "type": "long" + }, + { + "description": "ID of the shared filesystem", + "name": "id", "type": "string" }, + {}, { - "description": "path of the domain to which the shared filesystem", - "name": "domainpath", + "description": "path to mount the shared filesystem", + "name": "path", "type": "string" }, { - "description": "size of the shared filesystem in GiB", - "name": "sizegb", + "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": "name of the storage pool hosting the data volume", + "name": "storage", + "type": "string" }, { - "description": "ID of the availability zone", - "name": "zoneid", + "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 availability zone", + "name": "zonename", + "type": "string" + }, + { + "description": "the account associated with the shared filesystem", + "name": "account", + "type": "string" + }, + { + "description": "disk offering for the shared filesystem", + "name": "diskofferingname", + "type": "string" + }, + { + "description": "description of the shared filesystem", + "name": "description", + "type": "string" }, { "description": "ID of the storage fs vm", "name": "vmstate", "type": "string" }, + { + "description": "service offering ID for the shared filesystem", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "ID of the storage pool hosting the data volume", + "name": "storageid", + "type": "string" + }, + { + "description": "disk offering display text for the shared filesystem", + "name": "diskofferingdisplaytext", + "type": "string" + }, + { + "description": "provisioning type used in the shared filesystem", + "name": "provisioningtype", + "type": "string" + }, + { + "description": "ID of the availability zone", + "name": "zoneid", + "type": "string" + }, { "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", + "description": "ID of the storage fs data volume", + "name": "volumeid", "type": "string" }, { - "description": "the shared filesystem provider", - "name": "provider", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the state of the shared filesystem", + "name": "state", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "ID of the storage fs vm", + "name": "virtualmachineid", "type": "string" }, + { + "description": "name of the storage fs data volume", + "name": "volumename", + "type": "string" + }, + { + "description": "the domain associated with the shared filesystem", + "name": "domain", + "type": "string" + }, + { + "description": "the bytes allocated", + "name": "virtualsize", + "type": "long" + }, + {}, { "description": "the bytes actually consumed on disk", "name": "physicalsize", "type": "long" + } + ], + "since": "4.20.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": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, { - "description": "the domain associated with the shared filesystem", - "name": "domain", + "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": "Initiates the specified power action to the host's out-of-band management interface", + "isasync": true, + "name": "issueOutOfBandManagementPowerAction", + "params": [ + { + "description": "the ID of the host", + "length": 255, + "name": "hostid", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost", + "required": true, + "type": "uuid" }, { - "description": "the project name of the shared filesystem", - "name": "project", + "description": "out-of-band management power actions, valid actions are: ON, OFF, CYCLE, RESET, SOFT, STATUS", + "length": 255, + "name": "action", + "required": true, "type": "string" }, { - "description": "provisioning type used in the shared filesystem", - "name": "provisioningtype", + "description": "optional operation timeout in seconds that overrides the global or cluster-level out-of-band management timeout setting", + "length": 255, + "name": "timeout", + "required": false, + "type": "long" + } + ], + "related": "enableOutOfBandManagementForHost,disableOutOfBandManagementForHost,enableOutOfBandManagementForCluster,disableOutOfBandManagementForCluster,configureOutOfBandManagement,changeOutOfBandManagementPassword", + "response": [ + { + "description": "the out-of-band management interface address", + "name": "address", "type": "string" }, { - "description": "the account associated with the shared filesystem", - "name": "account", + "description": "the out-of-band management action (if issued)", + "name": "action", + "type": "string" + }, + { + "description": "true if out-of-band management is enabled for the host", + "name": "enabled", + "type": "boolean" + }, + { + "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" + }, + { + "description": "the ID of the host", + "name": "hostid", + "type": "string" + }, + { + "description": "the operation result description", + "name": "description", + "type": "string" + }, + { + "description": "the out-of-band management interface username", + "name": "username", + "type": "string" + }, + { + "description": "the operation result", + "name": "status", + "type": "boolean" + }, + {}, + { + "description": "the out-of-band management interface port", + "name": "port", + "type": "string" + }, + {}, + { + "description": "the out-of-band management driver for the host", + "name": "driver", "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the out-of-band management interface powerState of the host", + "name": "powerstate", + "type": "powerstate" } ], - "since": "4.20.0" + "since": "4.9.0" }, { "description": "Deletes network device.", @@ -28208,18 +28380,24 @@ "description": "Id of network device to delete", "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" } ], "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", @@ -28229,12 +28407,6 @@ "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" } ] }, @@ -28244,11 +28416,11 @@ "name": "updateImageStore", "params": [ { - "description": "The new name for the Image Store.", + "description": "The number of bytes CloudStack can use on this image storage.\n\tNOTE: this will be overwritten by the StatsCollector as soon as there is a SSVM to query the storage.", "length": 255, - "name": "name", + "name": "capacitybytes", "required": false, - "type": "string" + "type": "long" }, { "description": "Image Store UUID", @@ -28259,93 +28431,93 @@ "type": "uuid" }, { - "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.", + "description": "If set to true, it designates the corresponding image store to read-only, hence not considering them during storage migration", "length": 255, - "name": "capacitybytes", + "name": "readonly", "required": false, - "type": "long" + "type": "boolean" }, { - "description": "If set to true, it designates the corresponding image store to read-only, hence not considering them during storage migration", + "description": "The new name for the Image Store.", "length": 255, - "name": "readonly", + "name": "name", "required": false, - "type": "boolean" + "type": "string" } ], "related": "addSecondaryStorage,addSwift,listSwifts,addImageStore,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", "response": [ { - "description": "the url of the image store", - "name": "url", - "type": "string" + "description": "defines if store is read-only", + "name": "readonly", + "type": "boolean" }, { "description": "the scope of the image store", "name": "scope", "type": "scopetype" }, - { - "description": "defines if store is read-only", - "name": "readonly", - "type": "boolean" - }, { "description": "the host's currently used disk size", "name": "disksizeused", "type": "long" }, { - "description": "the Zone ID of the image store", - "name": "zoneid", + "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 Zone ID of the image store", + "name": "zoneid", + "type": "string" }, { - "description": "the provider name of the image store", - "name": "providername", + "description": "the Zone name of the image store", + "name": "zonename", "type": "string" }, - {}, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the url of the image store", + "name": "url", + "type": "string" }, { "description": "the protocol of the image store", "name": "protocol", "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 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 image store", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the Zone name of the image store", - "name": "zonename", + "description": "the provider name of the image store", + "name": "providername", "type": "string" }, { - "description": "the name of the image store", - "name": "name", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ], "since": "4.15.0" @@ -28356,38 +28528,42 @@ "name": "assignToLoadBalancerRule", "params": [ { - "description": "VM ID and IP map, vmidipmap[0].vmid=1 vmidipmap[0].vmip=10.1.1.75", + "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": "vmidipmap", + "name": "virtualmachineids", + "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,createVMFromBackup,createVMFromBackup,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", "required": false, - "since": "4.4", - "type": "map" + "type": "list" }, { - "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": "VM ID and IP map, vmidipmap[0].vmid=1 vmidipmap[0].vmip=10.1.1.75", "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": "vmidipmap", "required": false, - "type": "list" + "since": "4.4", + "type": "map" }, { "description": "the ID of the load balancer rule", "length": 255, "name": "id", - "related": "createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,createIpv6FirewallRule,updateIpv6FirewallRule", + "related": "createRoutingFirewallRule,listRoutingFirewallRules,createIpv6FirewallRule,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule", "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", @@ -28398,11 +28574,7 @@ "name": "jobstatus", "type": "integer" }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - } + {} ] }, { @@ -28411,77 +28583,77 @@ "name": "configureStorageAccess", "params": [ { - "description": "UUID of the host", + "description": "UUID of the cluster", "length": 255, - "name": "hostid", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,addBaremetalHost", + "name": "clusterid", + "related": "addCluster,updateCluster", "required": false, "type": "uuid" }, { - "description": "comma separated list of storage access groups for connecting the storage pools and the hosts", + "description": "UUID of the pod", "length": 255, - "name": "storageaccessgroups", + "name": "podid", + "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", "required": false, - "since": "4.21.0", - "type": "list" + "type": "uuid" }, { - "description": "UUID of the Storage Pool", + "description": "UUID of the zone", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "uuid" }, { - "description": "UUID of the pod", + "description": "UUID of the Storage Pool", "length": 255, - "name": "podid", - "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", "required": false, "type": "uuid" }, { - "description": "UUID of the cluster", + "description": "UUID of the host", "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", + "name": "hostid", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost", "required": false, "type": "uuid" }, { - "description": "UUID of the zone", + "description": "comma separated list of storage access groups for connecting the storage pools and the hosts", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "storageaccessgroups", "required": false, - "type": "uuid" + "since": "4.21.0", + "type": "list" } ], "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": "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.21.0" }, @@ -28490,21 +28662,6 @@ "isasync": false, "name": "listAsyncJobs", "params": [ - { - "description": "list only resources belonging to the domain specified", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", - "required": false, - "type": "uuid" - }, - { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", - "length": 255, - "name": "listall", - "required": false, - "type": "boolean" - }, { "description": "List by keyword", "length": 255, @@ -28513,30 +28670,30 @@ "type": "string" }, { - "description": "The start date of the async job (use format \"yyyy-MM-dd'T'HH:mm:ss'+'SSSS\")", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "startdate", + "name": "isrecursive", "required": false, - "type": "date" + "type": "boolean" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "", "length": 255, - "name": "isrecursive", + "name": "page", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "account", + "name": "listall", "required": false, - "type": "string" + "type": "boolean" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, @@ -28550,59 +28707,63 @@ "type": "uuid" }, { - "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 resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "The start date of the async job (use format \"yyyy-MM-dd'T'HH:mm:ss'+'SSSS\")", + "length": 255, + "name": "startdate", + "required": false, + "type": "date" } ], "related": "queryAsyncJobResult", "response": [ { - "description": "the result code for the job", - "name": "jobresultcode", + "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 instance/entity object related to the job", - "name": "jobinstancetype", + "description": "the account that executed the async command", + "name": "account", "type": "string" }, { - "description": "the unique ID of the instance/entity object related to the job", - "name": "jobinstanceid", + "description": "the user that executed the async command", + "name": "userid", "type": "string" }, { - "description": "the result type", - "name": "jobresulttype", - "type": "string" + "description": " the created date of the job", + "name": "created", + "type": "date" }, { - "description": "the account that executed the async command", - "name": "account", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the domain that executed the async command", - "name": "domainpath", + "description": "the msid of the management server on which the job is running", + "name": "managementserverid", "type": "string" }, { - "description": " the created date of the job", - "name": "created", - "type": "date" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the result code for the job", + "name": "jobresultcode", "type": "integer" }, { @@ -28611,45 +28772,56 @@ "type": "string" }, { - "description": "the user that executed the async command", - "name": "userid", + "description": "the instance/entity object related to the job", + "name": "jobinstancetype", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain that executed the async command", + "name": "domainpath", "type": "string" }, { - "description": "the msid of the management server on which the job is running", - "name": "managementserverid", + "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 progress information of the PENDING job", - "name": "jobprocstatus", - "type": "integer" + "description": "the account id that executed the async command", + "name": "accountid", + "type": "string" }, { - "description": "the result reason", - "name": "jobresult", - "type": "responseobject" + "description": "the domain id that executed the async command", + "name": "domainid", + "type": "string" + }, + { + "description": "the result type", + "name": "jobresulttype", + "type": "string" }, - {}, { "description": "the management server name of the host", "name": "managementservername", "type": "string" }, { - "description": "the domain id that executed the async command", - "name": "domainid", - "type": "string" + "description": "the result reason", + "name": "jobresult", + "type": "responseobject" }, { - "description": "the account id that executed the async command", - "name": "accountid", - "type": "string" + "description": "the progress information of the PENDING job", + "name": "jobprocstatus", + "type": "integer" } ] }, @@ -28659,17 +28831,9 @@ "name": "archiveAlerts", "params": [ { - "description": "the IDs of the alerts", - "length": 255, - "name": "ids", - "related": "listAlerts,listAlertTypes", - "required": false, - "type": "list" - }, - { - "description": "end date range to archive alerts (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")", + "description": "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": "enddate", + "name": "startdate", "required": false, "type": "date" }, @@ -28681,16 +28845,27 @@ "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\")", + "description": "the IDs of the alerts", "length": 255, - "name": "startdate", + "name": "ids", + "related": "listAlerts,listAlertTypes", + "required": false, + "type": "list" + }, + { + "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" } ], "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", @@ -28701,11 +28876,8 @@ "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", @@ -28728,6 +28900,7 @@ } ], "response": [ + {}, { "description": "true if operation is executed successfully", "name": "success", @@ -28748,8 +28921,7 @@ "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, - {} + } ] }, { @@ -28758,9 +28930,9 @@ "name": "createSecondaryStorageSelector", "params": [ { - "description": "The name identifying the heuristic rule.", + "description": "The resource type directed to a specific secondary storage by the selector. Valid options are: ISO, SNAPSHOT, TEMPLATE and VOLUME.", "length": 255, - "name": "name", + "name": "type", "required": true, "type": "string" }, @@ -28772,12 +28944,11 @@ "type": "string" }, { - "description": "The zone in which the heuristic rule will be applied.", + "description": "The name identifying the heuristic rule.", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "name", "required": true, - "type": "uuid" + "type": "string" }, { "description": "The heuristic rule, in JavaScript language. It is required that it returns the UUID of a secondary storage pool. An example of a rule is `if (snapshot.hypervisorType === 'KVM') { '7832f261-c602-4e8e-8580-2496ffbbc45d'; }` would allocate all snapshots with the KVM hypervisor to the specified secondary storage UUID.", @@ -28787,34 +28958,40 @@ "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 zone in which the heuristic rule will be applied.", "length": 255, - "name": "type", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": true, - "type": "string" + "type": "uuid" } ], "related": "listSecondaryStorageSelectors,updateSecondaryStorageSelector", "response": [ {}, { - "description": "When the heuristic was removed.", - "name": "removed", - "type": "date" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "ID of the heuristic.", - "name": "id", + "description": "The resource type directed to a specific secondary storage by the selector. Valid options are: ISO, SNAPSHOT, TEMPLATE and VOLUME.", + "name": "type", "type": "string" }, { - "description": "The zone which the heuristic is valid upon.", - "name": "zoneid", + "description": "When the heuristic was created.", + "name": "created", + "type": "date" + }, + { + "description": "Name of the heuristic.", + "name": "name", "type": "string" }, { - "description": "The resource type directed to a specific secondary storage by the selector. Valid options are: ISO, SNAPSHOT, TEMPLATE and VOLUME.", - "name": "type", + "description": "Description of the heuristic.", + "name": "description", "type": "string" }, { @@ -28822,30 +28999,25 @@ "name": "heuristicrule", "type": "string" }, + {}, { - "description": "When the heuristic was created.", - "name": "created", + "description": "When the heuristic was removed.", + "name": "removed", "type": "date" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The zone which the heuristic is valid upon.", + "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 heuristic.", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Description of the heuristic.", - "name": "description", + "description": "ID of the heuristic.", + "name": "id", "type": "string" } ], @@ -28863,14 +29035,6 @@ "required": true, "type": "string" }, - { - "description": "the Physical Network ID", - "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", - "required": true, - "type": "uuid" - }, { "description": "Credentials to access the Brocade VCS Switch API", "length": 255, @@ -28884,19 +29048,32 @@ "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": "name of the provider", "name": "provider", "type": "string" }, + {}, { - "description": "device name", - "name": "brocadedevicename", + "description": "the current status of the latest 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" }, { @@ -28904,25 +29081,20 @@ "name": "hostname", "type": "string" }, + {}, { "description": "the physical Network to which this Brocade VCS 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", + "description": "device id of the Brocade Vcs", + "name": "vcsdeviceid", "type": "string" }, - {}, { - "description": "device id of the Brocade Vcs", - "name": "vcsdeviceid", + "description": "device name", + "name": "brocadedevicename", "type": "string" } ] @@ -28932,13 +29104,6 @@ "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, @@ -28946,6 +29111,13 @@ "required": false, "type": "map" }, + { + "description": "Delete tags for resource id(s)", + "length": 255, + "name": "resourceids", + "required": true, + "type": "list" + }, { "description": "Delete tag by resource type", "length": 255, @@ -28955,17 +29127,6 @@ } ], "response": [ - {}, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "true if operation is executed successfully", "name": "success", @@ -28976,7 +29137,18 @@ "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" }, @@ -28986,19 +29158,19 @@ "name": "createTungstenFabricTagType", "params": [ { - "description": "the ID of zone", + "description": "Tungsten-Fabric tag type name", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "name", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "Tungsten-Fabric tag type name", + "description": "the ID of zone", "length": 255, - "name": "name", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": true, - "type": "string" + "type": "uuid" } ], "related": "listTungstenFabricTagType", @@ -29009,14 +29181,13 @@ "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 tag type uuid", - "name": "uuid", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, { @@ -29025,78 +29196,17 @@ "type": "string" }, {}, - { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", - "type": "string" - }, - { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" - } - ] - }, - { - "description": "Restarts the network; includes 1) restarting network elements - virtual routers, DHCP servers 2) reapplying all public IPs 3) reapplying loadBalancing/portForwarding rules", - "isasync": true, - "name": "restartNetwork", - "params": [ - { - "description": "If cleanup old network elements", - "length": 255, - "name": "cleanup", - "required": false, - "type": "boolean" - }, - { - "description": "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, - "name": "livepatch", - "required": false, - "since": "4.17.0", - "type": "boolean" - }, - { - "description": "Turn the network into a network with redundant routers.", - "length": 255, - "name": "makeredundant", - "required": false, - "since": "4.11.1", - "type": "boolean" - } - ], - "response": [ - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Tungsten-Fabric tag type uuid", + "name": "uuid", "type": "string" - }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - {}, - {} + } ] }, { @@ -29105,12 +29215,19 @@ "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": "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, @@ -29119,30 +29236,29 @@ "type": "string" }, { - "description": "Path of the domain that the user belongs to. Example: domain=/com/cloud/internal. If no domain is passed in, the ROOT (/) domain is assumed.", + "description": "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": "domain", - "required": false, + "name": "password", + "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, - "name": "domainId", - "required": false, - "type": "long" } ], "related": "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": "last name of the user", + "name": "lastname", + "type": "string" + }, + { + "description": "Two factor authentication issuer", + "name": "issuerfor2fa", "type": "string" }, { @@ -29151,18 +29267,19 @@ "type": "string" }, { - "description": "Two factor authentication issuer", - "name": "issuerfor2fa", + "description": "Session key that can be passed in subsequent Query command calls", + "name": "sessionkey", "type": "string" }, { - "description": "the account type (admin, domain-admin, read-only-admin, user)", - "name": "type", + "description": "Two factor authentication provider", + "name": "providerfor2fa", "type": "string" }, + {}, { - "description": "user time zone", - "name": "timezone", + "description": "the account name the user belongs to", + "name": "account", "type": "string" }, { @@ -29171,13 +29288,13 @@ "type": "string" }, { - "description": "Two factor authentication provider", - "name": "providerfor2fa", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "User ID", - "name": "userid", + "description": "user time zone", + "name": "timezone", "type": "string" }, { @@ -29185,6 +29302,16 @@ "name": "timeout", "type": "integer" }, + { + "description": "the account type (admin, domain-admin, read-only-admin, user)", + "name": "type", + "type": "string" + }, + { + "description": "first name of the user", + "name": "firstname", + "type": "string" + }, { "description": "user time zoneoffset", "name": "timezoneoffset", @@ -29195,7 +29322,16 @@ "name": "jobid", "type": "string" }, - {}, + { + "description": "User ID", + "name": "userid", + "type": "string" + }, + { + "description": "Username", + "name": "username", + "type": "string" + }, { "description": "Domain ID that the user belongs to", "name": "domainid", @@ -29205,33 +29341,69 @@ "description": "Is two factor authentication verified", "name": "is2faverified", "type": "string" + } + ] + }, + { + "description": "Restarts the network; includes 1) restarting network elements - virtual routers, DHCP servers 2) reapplying all public IPs 3) reapplying loadBalancing/portForwarding rules", + "isasync": true, + "name": "restartNetwork", + "params": [ + { + "description": "Turn the network into a network with redundant routers.", + "length": 255, + "name": "makeredundant", + "required": false, + "since": "4.11.1", + "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Live patches the router software before restarting it. This parameter will only work when 'cleanup' is false.", + "length": 255, + "name": "livepatch", + "required": false, + "since": "4.17.0", + "type": "boolean" + }, + { + "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": "If cleanup old network elements", + "length": 255, + "name": "cleanup", + "required": false, + "type": "boolean" + } + ], + "response": [ {}, { - "description": "last name of the user", - "name": "lastname", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "Session key that can be passed in subsequent Query command calls", - "name": "sessionkey", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "Management Server ID that the user logged to", - "name": "managementserverid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "first name of the user", - "name": "firstname", - "type": "string" - } + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {} ] }, { @@ -29239,6 +29411,21 @@ "isasync": false, "name": "listHypervisorCapabilities", "params": [ + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "ID of the hypervisor capability", + "length": 255, + "name": "id", + "related": "listHypervisorCapabilities", + "required": false, + "type": "uuid" + }, { "description": "List by keyword", "length": 255, @@ -29253,81 +29440,66 @@ "required": false, "type": "string" }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, { "description": "", "length": 255, "name": "page", "required": false, "type": "integer" - }, - { - "description": "ID of the hypervisor capability", - "length": 255, - "name": "id", - "related": "listHypervisorCapabilities", - "required": false, - "type": "uuid" } ], "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": "the maximum number of Data Volumes that can be attached for this hypervisor", - "name": "maxdatavolumeslimit", - "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": "true if security group is supported", + "name": "securitygroupenabled", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the hypervisor capabilities row", + "name": "id", "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 maximum number of Data Volumes that can be attached for this hypervisor", + "name": "maxdatavolumeslimit", + "type": "integer" }, { - "description": "the hypervisor version", - "name": "hypervisorversion", + "description": "the hypervisor type", + "name": "hypervisor", "type": "string" }, + {}, { "description": "the maximum number of guest vms recommended for this hypervisor", "name": "maxguestslimit", "type": "long" }, { - "description": "true if security group is supported", - "name": "securitygroupenabled", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the hypervisor version", + "name": "hypervisorversion", + "type": "string" }, { "description": "true if storage motion is supported", @@ -29344,45 +29516,45 @@ "name": "deleteProjectRole", "params": [ { - "description": "ID of the project from where the role is to be deleted", + "description": "ID of the project role to be deleted", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "id", + "related": "createProjectRole,listProjectRoles,updateProjectRole", "required": true, "type": "uuid" }, { - "description": "ID of the project role to be deleted", + "description": "ID of the project from where the role is to be deleted", "length": 255, - "name": "id", - "related": "createProjectRole,listProjectRoles,updateProjectRole", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": true, "type": "uuid" } ], "response": [ + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, + {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - {}, - {} + } ], "since": "4.15.0" }, @@ -29401,7 +29573,6 @@ ], "related": "", "response": [ - {}, {}, { "description": "variable", @@ -29413,16 +29584,17 @@ "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 UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } + {} ], "since": "4.20" }, @@ -29432,11 +29604,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 +29626,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 +29639,35 @@ "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": "quota consumed", + "name": "quota", + "type": "bigdecimal" }, { - "description": "account name", - "name": "account", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "domain id", - "name": "domain", - "type": "long" + "description": "usage unit", + "name": "unit", + "type": "string" }, + {}, { "description": "usage type name", "name": "name", "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", @@ -29508,14 +29675,19 @@ "type": "long" }, { - "description": "usage unit", - "name": "unit", - "type": "string" + "description": "domain id", + "name": "domain", + "type": "long" }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "account name", + "name": "account", "type": "string" } ], @@ -29543,22 +29715,22 @@ ], "related": "", "response": [ + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, { "description": "SolidFire Account ID", "name": "solidFireAccountId", "type": "long" }, - {}, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" } ] }, @@ -29578,14 +29750,10 @@ ], "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 api name or wildcard rule", + "name": "rule", "type": "string" }, { @@ -29594,8 +29762,13 @@ "type": "integer" }, { - "description": "the name of the role to which the role permission belongs", - "name": "rolename", + "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" }, { @@ -29603,15 +29776,14 @@ "name": "jobid", "type": "string" }, - {}, { "description": "the ID of the role to which the role permission belongs", "name": "roleid", "type": "string" }, { - "description": "the api name or wildcard rule", - "name": "rule", + "description": "the name of the role to which the role permission belongs", + "name": "rolename", "type": "string" }, { @@ -29629,11 +29801,19 @@ "name": "listDedicatedGuestVlanRanges", "params": [ { - "description": "the dedicated guest vlan range", + "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": "guestvlanrange", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, - "type": "string" + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { "description": "zone of the guest VLAN range", @@ -29659,61 +29839,49 @@ "type": "string" }, { - "description": "project who will own the guest VLAN range", + "description": "the dedicated guest vlan range", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "guestvlanrange", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "physical network id of the guest VLAN range", + "description": "List by keyword", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "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": "project who will own the guest VLAN range", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, "type": "uuid" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, - { - "description": "", + "description": "physical network id of the guest VLAN range", "length": 255, - "name": "page", + "name": "physicalnetworkid", + "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", "required": false, - "type": "integer" + "type": "uuid" } ], "related": "dedicateGuestVlanRange", "response": [ + {}, { - "description": "the domain name of the guest VLAN range", - "name": "domain", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the account of the guest VLAN range", + "name": "account", "type": "string" }, { @@ -29721,51 +29889,55 @@ "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 guest vlan range", "name": "projectid", "type": "string" }, { - "description": "the account of the guest VLAN range", - "name": "account", + "description": "the domain name of the guest VLAN range", + "name": "domain", "type": "string" }, { - "description": "the domain ID of the guest VLAN range", - "name": "domainid", - "type": "string" + "description": "the zone of the guest vlan range", + "name": "zoneid", + "type": "long" }, - {}, { - "description": "the ID of the guest VLAN range", - "name": "id", + "description": "the guest VLAN range", + "name": "guestvlanrange", "type": "string" }, { - "description": "the zone of the guest vlan range", - "name": "zoneid", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the domain ID of the guest VLAN range", + "name": "domainid", + "type": "string" }, { "description": "the physical network of the guest vlan range", "name": "physicalnetworkid", "type": "long" }, - {}, + { + "description": "the ID of the guest VLAN range", + "name": "id", + "type": "string" + }, { "description": "the project name of the guest vlan range", "name": "project", "type": "string" }, + {}, { - "description": "the guest VLAN range", - "name": "guestvlanrange", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ] @@ -29776,33 +29948,25 @@ "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", + "description": "list network ACL items by protocol", "length": 255, - "name": "action", + "name": "protocol", "required": false, "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "account", + "name": "tags", "required": false, - "type": "string" + "type": "map" }, { - "description": "list network ACL items by network ID", + "description": "List by keyword", "length": 255, - "name": "networkid", - "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { "description": "list only resources belonging to the domain specified", @@ -29813,24 +29977,17 @@ "type": "uuid" }, { - "description": "List resources by tags (key/value pairs)", - "length": 255, - "name": "tags", - "required": false, - "type": "map" - }, - { - "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": "Lists network ACL Item with the specified ID", + "description": "list network ACL items by network ID", "length": 255, - "name": "id", - "related": "createNetworkACL,listNetworkACLs,updateNetworkACLItem,moveNetworkAclItem", + "name": "networkid", + "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, "type": "uuid" }, @@ -29842,117 +29999,75 @@ "type": "boolean" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "list network ACL items by ACL ID", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "aclid", + "related": "createNetworkACLList,listNetworkACLLists", "required": false, "type": "uuid" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "", "length": 255, - "name": "fordisplay", + "name": "pagesize", "required": false, - "since": "4.4", - "type": "boolean" + "type": "integer" }, { - "description": "list network ACL items by traffic type - ingress or egress", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "traffictype", + "name": "account", "required": false, "type": "string" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "list network ACL items by protocol", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "protocol", + "name": "fordisplay", "required": false, - "type": "string" + "since": "4.4", + "type": "boolean" }, { - "description": "list network ACL items by ACL ID", + "description": "Lists network ACL Item with the specified ID", "length": 255, - "name": "aclid", - "related": "createNetworkACLList,listNetworkACLLists", + "name": "id", + "related": "createNetworkACL,listNetworkACLs,updateNetworkACLItem,moveNetworkAclItem", "required": false, "type": "uuid" }, { - "description": "", + "description": "list network ACL items by action", "length": 255, - "name": "page", + "name": "action", "required": false, - "type": "integer" - } - ], - "related": "createNetworkACL,updateNetworkACLItem,moveNetworkAclItem", - "response": [ - { - "description": "an explanation on why this ACL rule is being applied", - "name": "reason", "type": "string" }, - {}, { - "description": "the state of the rule", - "name": "state", - "type": "string" + "description": "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 traffic type for the ACL", + "description": "list network ACL items by traffic type - ingress or egress", + "length": 255, "name": "traffictype", + "required": false, "type": "string" - }, - { - "description": "Action of ACL Item. Allow/Deny", - "name": "action", - "type": "string" - }, - { - "description": "the ID of the ACL Item", - "name": "id", - "type": "string" - }, - { - "description": "type of the icmp message being sent", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, - { - "description": "error code for this icmp message", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the protocol of the ACL", - "name": "protocol", - "type": "string" - }, - { - "description": "the starting port of ACL's port range", - "name": "startport", - "type": "string" - }, - { - "description": "Number of the ACL Item", - "name": "number", - "type": "integer" - }, + } + ], + "related": "createNetworkACL,updateNetworkACLItem,moveNetworkAclItem", + "response": [ { "description": "is rule for display to the regular user", "name": "fordisplay", @@ -29963,23 +30078,18 @@ "name": "tags", "response": [ { - "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 account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -29993,56 +30103,118 @@ "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "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" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "tag value", + "name": "value", "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": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "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": "the ID of the ACL this item belongs to", - "name": "aclid", + "description": "the current status of the latest 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": "Number of the ACL Item", + "name": "number", + "type": "integer" + }, + { + "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 ending port of ACL's port range", - "name": "endport", + "description": "the traffic type for the ACL", + "name": "traffictype", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the starting port of ACL's port range", + "name": "startport", + "type": "string" + }, + { + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", + "type": "string" + }, + { + "description": "Action of ACL Item. Allow/Deny", + "name": "action", + "type": "string" + }, + { + "description": "the ID of the ACL Item", + "name": "id", + "type": "string" + }, + {}, + {}, + { + "description": "type of the icmp message being sent", + "name": "icmptype", + "type": "integer" + }, + { + "description": "an explanation on why this ACL rule is being applied", + "name": "reason", + "type": "string" + }, + { + "description": "the protocol of the ACL", + "name": "protocol", + "type": "string" + }, + { + "description": "the state of the rule", + "name": "state", + "type": "string" + }, + { + "description": "the ID of the ACL this item belongs to", + "name": "aclid", "type": "string" } ] @@ -30052,6 +30224,14 @@ "isasync": true, "name": "copyTemplate", "params": [ + { + "description": "Template ID.", + "length": 255, + "name": "id", + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "required": true, + "type": "uuid" + }, { "description": "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, @@ -30075,190 +30255,110 @@ "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "list" - }, - { - "description": "Template ID.", - "length": 255, - "name": "id", - "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", - "required": true, - "type": "uuid" } ], - "related": "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 name of the OS type for this template.", - "name": "ostypename", - "type": "string" - }, - { - "description": "the date this template was removed", - "name": "removed", - "type": "date" - }, - { - "description": "the project name of the template", - "name": "project", + "description": "the ID of the zone for this template", + "name": "zoneid", "type": "string" }, { - "description": "The name of extension linked to this template", - "name": "extensionname", + "description": "the name of the secondary storage host for the template", + "name": "hostname", "type": "string" }, - {}, { - "description": "the ID of the zone for this template", - "name": "zoneid", - "type": "string" + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", + "type": "boolean" }, { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", + "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", + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", "type": "string" }, { - "description": "the account name to which the template belongs", - "name": "account", + "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 template display text", + "name": "displaytext", "type": "string" }, { - "description": "the id of userdata linked to this template", - "name": "userdataid", + "description": "the tag of this template", + "name": "templatetag", "type": "string" }, { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", "type": "boolean" }, { - "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": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", - "type": "map" + "description": "path of the Domain the template belongs to", + "name": "domainpath", + "type": "string" }, { - "description": "the type of the template", - "name": "templatetype", + "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": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", + "type": "boolean" }, { - "description": "the name of the secondary storage host for the template", - "name": "hostname", + "description": "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 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": "the format of the template.", - "name": "format", - "type": "imageformat" + "description": "the ID of the secondary storage host for the template", + "name": "hostid", + "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "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 this template is a public template, false otherwise", - "name": "ispublic", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", + "description": "If true it indicates that the template can be used for CKS cluster deployments", + "name": "forcks", "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 account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - } - ], - "type": "set" + "description": "the size of the template", + "name": "size", + "type": "long" }, { "description": "true if the template is extractable, false otherwise", @@ -30266,99 +30366,109 @@ "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", - "type": "boolean" + "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 type of the template", + "name": "templatetype", "type": "string" }, { - "description": "the template ID", - "name": "id", + "description": "the template name", + "name": "name", "type": "string" }, { - "description": "the name of the domain to which the template belongs", - "name": "domain", - "type": "string" + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "the template display text", - "name": "displaytext", + "description": "the URL which the template/iso is registered from", + "name": "url", "type": "string" }, { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", + "description": "the date this template was created", + "name": "created", + "type": "date" + }, + { + "description": "The ID of extension linked to this template", + "name": "extensionid", "type": "string" }, {}, { - "description": "the tag of this template", - "name": "templatetag", + "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 name of the OS type for this template.", + "name": "ostypename", + "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": "the project id of the template", - "name": "projectid", + "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": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "checksum of the template", - "name": "checksum", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", - "type": "string" + "description": "the date this template was removed", + "name": "removed", + "type": "date" }, { - "description": "the physical size of the template", - "name": "physicalsize", - "type": "long" + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" }, { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", - "type": "boolean" + "description": "the format of the template.", + "name": "format", + "type": "imageformat" }, { - "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", - "name": "userdataparams", + "description": "the name of the zone for this template", + "name": "zonename", "type": "string" }, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "the id of userdata linked to this template", + "name": "userdataid", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the account name to which the template belongs", + "name": "account", + "type": "string" + }, + { + "description": "the name of the domain to which the template belongs", + "name": "domain", "type": "string" }, { @@ -30366,25 +30476,102 @@ "name": "userdataname", "type": "string" }, - {}, { - "description": "the template name", - "name": "name", + "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 template ID", + "name": "id", "type": "string" }, { - "description": "the status of the template", - "name": "status", - "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", + "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": "id of the resource", + "name": "resourceid", + "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": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + } + ], + "type": "set" + }, + {}, + { + "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", + "description": "the project id of the template", + "name": "projectid", "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" }, { @@ -30393,53 +30580,38 @@ "type": "string" }, { - "description": "the date this template was created", - "name": "created", - "type": "date" - }, - { - "description": "the size of the template", - "name": "size", + "description": "the physical size of the template", + "name": "physicalsize", "type": "long" }, { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", - "type": "boolean" - }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, - { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", + "description": "the ID of the OS type for this template.", + "name": "ostypeid", "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": "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 ready to be deployed from, false otherwise.", + "name": "isready", "type": "boolean" }, { - "description": "the processor bit size", - "name": "bits", - "type": "int" + "description": "the project name of the template", + "name": "project", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "The ID of extension linked to this template", - "name": "extensionid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ] @@ -30452,7 +30624,7 @@ { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, @@ -30463,13 +30635,6 @@ "required": false, "type": "string" }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, { "description": "nicira nvp device ID", "length": 255, @@ -30477,99 +30642,102 @@ "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 vlan of the network. This parameter is visible to ROOT admins only", + "name": "vlan", "type": "string" }, { - "description": "the date this network was created", - "name": "created", - "type": "date" - }, - { - "description": "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": "display text of the network offering the network is created from", + "name": "networkofferingdisplaytext", "type": "string" }, { - "description": "true if network is system, false otherwise", - "name": "issystem", - "type": "boolean" + "description": "the details of the network", + "name": "details", + "type": "map" }, { - "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 BGP peers for the network", - "name": "bgppeers", - "type": "set" + "description": "the type of the network", + "name": "type", + "type": "string" }, { - "description": "the displaytext of the network", - "name": "displaytext", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "acl type - access type to the network", - "name": "acltype", + "description": "Broadcast domain type of the network", + "name": "broadcastdomaintype", "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 owner of the network", + "name": "account", "type": "string" }, { - "description": "true if network supports specifying ip ranges, false otherwise", - "name": "specifyipranges", - "type": "boolean" + "description": "the second IPv6 DNS for the network", + "name": "ip6dns2", + "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "The IPv4 routing type of network", + "name": "ip4routing", "type": "string" }, + {}, { - "description": "if network offering supports vm autoscaling feature", - "name": "supportsvmautoscaling", - "type": "boolean" + "description": "acl type - access type to the network", + "name": "acltype", + "type": "string" }, { - "description": "If the network has redundant routers enabled", - "name": "redundantrouter", - "type": "boolean" + "description": "AS NUMBER", + "name": "asnumber", + "type": "long" }, { - "description": "true if network supports specifying vlan, false otherwise", - "name": "specifyvlan", + "description": "an optional field, whether to the display the network to the end user or not.", + "name": "displaynetwork", "type": "boolean" }, { - "description": "list networks available for vm deployment", - "name": "canusefordeploy", - "type": "boolean" + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "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", + "type": "string" }, { - "description": "VPC the network belongs to", - "name": "vpcid", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { @@ -30578,93 +30746,102 @@ "type": "string" }, { - "description": "path of the Domain the network belongs to", - "name": "domainpath", - "type": "string" + "description": "MTU configured on the network VR's private interfaces", + "name": "privatemtu", + "type": "integer" }, { - "description": "display text of the network offering the network is created from", - "name": "networkofferingdisplaytext", - "type": "string" + "description": "if network offering supports vm autoscaling feature", + "name": "supportsvmautoscaling", + "type": "boolean" }, { - "description": "true if users from subdomains can access the domain level network", - "name": "subdomainaccess", - "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": "broadcast uri of the network. This parameter is visible to ROOT admins only", - "name": "broadcasturi", + "description": "ACL Id associated with the VPC network", + "name": "aclid", "type": "string" }, { - "description": "the domain name of the network owner", - "name": "domain", - "type": "string" + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" }, { - "description": "The internet protocol of network offering", - "name": "internetprotocol", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "the owner of the network", - "name": "account", - "type": "string" + "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": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, - {}, { - "description": "the network's netmask", - "name": "netmask", + "description": "the name of the zone the network belongs to", + "name": "zonename", "type": "string" }, + { + "description": "The BGP peers for the network", + "name": "bgppeers", + "type": "set" + }, { "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": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" - }, - { - "description": "state of the network provider", - "name": "state", - "type": "string" - }, { "description": "the destination physical network", "name": "destinationphysicalnetworkid", "type": "string" }, + { + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" + }, { "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": "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" } ], "type": "list" @@ -30690,38 +30867,38 @@ } ], "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 physical network id", + "name": "physicalnetworkid", + "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the second IPv4 DNS for the network", + "name": "dns2", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if users from subdomains can access the domain level network", + "name": "subdomainaccess", + "type": "boolean" }, { - "description": "AS NUMBER", - "name": "asnumber", - "type": "long" + "description": "list networks that are persistent", + "name": "ispersistent", + "type": "boolean" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "If the network has redundant routers enabled", + "name": "redundantrouter", + "type": "boolean" + }, + { + "description": "the domain id of the network owner", + "name": "domainid", "type": "string" }, { @@ -30730,44 +30907,39 @@ "type": "string" }, { - "description": "the name of the zone the network belongs to", - "name": "zonename", + "description": "state of the network", + "name": "state", "type": "string" }, { - "description": "the second IPv6 DNS for the network", - "name": "ip6dns2", + "description": "the domain name of the network owner", + "name": "domain", "type": "string" }, { - "description": "the id of the network", - "name": "id", - "type": "string" + "description": "list networks available for vm deployment", + "name": "canusefordeploy", + "type": "boolean" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "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": "true if network is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "Name of the VPC to which this network belongs", - "name": "vpcname", + "description": "related to what other network configuration", + "name": "related", "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", - "type": "string" + "description": "true if network supports specifying ip ranges, false otherwise", + "name": "specifyipranges", + "type": "boolean" }, { "description": "The routes for the network to ease adding route in upstream router", @@ -30775,43 +30947,43 @@ "type": "set" }, { - "description": "the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes", - "name": "reservediprange", + "description": "the displaytext of the network", + "name": "displaytext", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "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": "The routes for the network to ease adding route in upstream router", - "name": "ip6routes", - "type": "set" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "true network requires restart", - "name": "restartrequired", + "description": "true if network offering is ip conserve mode enabled", + "name": "networkofferingconservemode", "type": "boolean" }, { - "description": "The external id of the network", - "name": "externalid", + "description": "Name of the VPC to which this network belongs", + "name": "vpcname", "type": "string" }, { - "description": "true if guest network default egress policy is allow; false if default egress policy is deny", - "name": "egressdefaultpolicy", - "type": "boolean" + "description": "the ID of the Network associated with this private gateway", + "name": "associatednetworkid", + "type": "string" }, { - "description": "Broadcast domain type of the network", - "name": "broadcastdomaintype", + "description": "UUID of AS NUMBER", + "name": "asnumberid", "type": "string" }, { - "description": "Tungsten-Fabric virtual router the network belongs to", - "name": "tungstenvirtualrouteruuid", + "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" }, { @@ -30820,18 +30992,48 @@ "type": "string" }, { - "description": "UUID of AS NUMBER", - "name": "asnumberid", + "description": "The Ipv6 routing type of network offering", + "name": "ip6routing", "type": "string" }, { - "description": "true if network is default, false otherwise", - "name": "isdefault", + "description": "the network domain", + "name": "networkdomain", + "type": "string" + }, + { + "description": "the first IPv4 DNS for the network", + "name": "dns1", + "type": "string" + }, + { + "description": "true if network supports specifying vlan, false otherwise", + "name": "specifyvlan", "type": "boolean" }, { - "description": "the physical network id", - "name": "physicalnetworkid", + "description": "VPC the network belongs to", + "name": "vpcid", + "type": "string" + }, + { + "description": "MTU configured on the network VR's public facing interfaces", + "name": "publicmtu", + "type": "integer" + }, + { + "description": "the traffic type of the network", + "name": "traffictype", + "type": "string" + }, + { + "description": "ACL name associated with the VPC network", + "name": "aclname", + "type": "string" + }, + { + "description": "the name of the Network associated with this private gateway", + "name": "associatednetwork", "type": "string" }, { @@ -30840,8 +31042,13 @@ "type": "string" }, { - "description": "name of the network offering the network is created from", - "name": "networkofferingname", + "description": "The external id of the network", + "name": "externalid", + "type": "string" + }, + { + "description": "Tungsten-Fabric virtual router the network belongs to", + "name": "tungstenvirtualrouteruuid", "type": "string" }, { @@ -30849,28 +31056,28 @@ "name": "tags", "response": [ { - "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 value", + "name": "value", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -30879,81 +31086,61 @@ "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": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "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 project name where tag belongs to", + "name": "project", "type": "string" } ], "type": "list" }, { - "description": "ACL Id associated with the VPC network", - "name": "aclid", - "type": "string" - }, - { - "description": "network offering id the network is created from", - "name": "networkofferingid", - "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 name of the Network associated with this private gateway", - "name": "associatednetwork", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "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 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": "true network requires restart", + "name": "restartrequired", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the first IPv6 DNS for the network", + "name": "ip6dns1", "type": "string" }, { - "description": "the first IPv6 DNS for the network", - "name": "ip6dns1", + "description": "The internet protocol of network offering", + "name": "internetprotocol", "type": "string" }, { @@ -30962,48 +31149,33 @@ "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 date this network was created", + "name": "created", + "type": "date" }, { - "description": "the traffic type of the network", - "name": "traffictype", + "description": "the name of the network", + "name": "name", "type": "string" }, { - "description": "the second IPv4 DNS for the network", - "name": "dns2", + "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", + "name": "broadcasturi", "type": "string" }, { - "description": "the ID of the Network associated with this private gateway", - "name": "associatednetworkid", + "description": "network offering id the network is created from", + "name": "networkofferingid", "type": "string" }, { - "description": "the name of the network", - "name": "name", + "description": "the network's netmask", + "name": "netmask", "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", + "description": "name of the network offering the network is created from", + "name": "networkofferingname", "type": "string" } ] @@ -31023,26 +31195,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": "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" } ], @@ -31056,25 +31228,16 @@ { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "list ovs elements by network service provider id", - "length": 255, - "name": "nspid", - "related": "addNetworkServiceProvider,listNetworkServiceProviders,listTrafficTypes", - "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", @@ -31091,18 +31254,38 @@ "type": "string" }, { - "description": "", + "description": "list ovs elements by id", "length": 255, - "name": "page", + "name": "id", + "related": "listOvsElements,configureOvsElement", "required": false, - "type": "integer" + "type": "uuid" + }, + { + "description": "list ovs elements by network service provider id", + "length": 255, + "name": "nspid", + "related": "addNetworkServiceProvider,listNetworkServiceProviders", + "required": false, + "type": "uuid" } ], "related": "configureOvsElement", "response": [ { - "description": "the domain ID associated with the provider", - "name": "domainid", + "description": "the id of the ovs", + "name": "id", + "type": "string" + }, + { + "description": "Enabled/Disabled the service provider", + "name": "enabled", + "type": "boolean" + }, + {}, + { + "description": "the project name of the address", + "name": "project", "type": "string" }, { @@ -31111,24 +31294,24 @@ "type": "integer" }, { - "description": "the id of the ovs", - "name": "id", + "description": "the physical network service provider id of the provider", + "name": "nspid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain associated with the provider", + "name": "domain", "type": "string" }, { - "description": "the domain associated with the provider", - "name": "domain", + "description": "path of the domain to which the provider belongs", + "name": "domainpath", "type": "string" }, { - "description": "Enabled/Disabled the service provider", - "name": "enabled", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { "description": "the project id of the ipaddress", @@ -31136,26 +31319,15 @@ "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "the domain ID associated with the provider", + "name": "domainid", "type": "string" }, {}, - {}, - { - "description": "path of the domain to which the provider belongs", - "name": "domainpath", - "type": "string" - }, { "description": "the account associated with the provider", "name": "account", "type": "string" - }, - { - "description": "the physical network service provider id of the provider", - "name": "nspid", - "type": "string" } ] }, @@ -31164,6 +31336,13 @@ "isasync": true, "name": "associateUcsProfileToBlade", "params": [ + { + "description": "profile dn", + "length": 255, + "name": "profiledn", + "required": true, + "type": "string" + }, { "description": "blade id", "length": 255, @@ -31179,55 +31358,87 @@ "related": "listUcsManagers,addUcsManager", "required": true, "type": "uuid" - }, - { - "description": "profile dn", - "length": 255, - "name": "profiledn", - "required": true, - "type": "string" } ], "related": "", "response": [ + {}, { - "description": "associated ucs profile dn", - "name": "profiledn", - "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": "ucs blade dn", + "name": "bladedn", + "type": "string" + }, { "description": "ucs blade id", "name": "id", "type": "string" }, { - "description": "cloudstack host id this blade associates to", - "name": "hostid", + "description": "associated ucs profile dn", + "name": "profiledn", "type": "string" }, - {}, { "description": "ucs manager id", "name": "ucsmanagerid", "type": "string" }, { - "description": "ucs blade dn", - "name": "bladedn", + "description": "cloudstack host id this blade associates to", + "name": "hostid", + "type": "string" + }, + {} + ] + }, + { + "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" }, { "description": "Updates a VMware datacenter details for a zone", @@ -31243,18 +31454,18 @@ "type": "uuid" }, { - "description": "Specify if cluster level username/password/url and host level guid need to be updated as well. By default this is true.", + "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": "isrecursive", + "name": "vcenter", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "The password for specified username.", + "description": "Specify if cluster level username/password/url and host level guid need to be updated as well. By default this is true.", "length": 255, - "name": "password", + "name": "isrecursive", "required": false, - "type": "string" + "type": "boolean" }, { "description": "The username required to connect to resource.", @@ -31264,22 +31475,27 @@ "type": "string" }, { - "description": "VMware datacenter name.", + "description": "The password for specified username.", "length": 255, - "name": "name", + "name": "password", "required": false, "type": "string" }, { - "description": "The name/IP of vCenter. Make sure it is IP address or full qualified domain name for host running vCenter server.", + "description": "VMware datacenter name.", "length": 255, - "name": "vcenter", + "name": "name", "required": false, "type": "string" } ], "related": "addVmwareDc,listVmwareDcs", "response": [ + { + "description": "The VMware Datacenter ID", + "name": "id", + "type": "string" + }, { "description": "The VMware vCenter name/ip", "name": "vcenter", @@ -31287,13 +31503,8 @@ }, {}, { - "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", + "description": "The VMware Datacenter name", + "name": "name", "type": "string" }, { @@ -31301,58 +31512,19 @@ "name": "jobstatus", "type": "integer" }, - { - "description": "The VMware Datacenter name", - "name": "name", - "type": "string" - }, - {}, - { - "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" + "description": "the Zone ID associated with this VMware Datacenter", + "name": "zoneid", + "type": "long" } ], - "since": "4.18.0" + "since": "4.12.0" }, { "description": "Starts a router.", @@ -31378,9 +31550,9 @@ "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": "healthchecks", + "type": "list" }, { "description": "the id of the router", @@ -31392,12 +31564,12 @@ "name": "jobstatus", "type": "integer" }, - {}, { - "description": "the id of the router", - "name": "healthchecks", - "type": "list" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, + {}, {} ], "since": "4.14.0" @@ -31410,57 +31582,57 @@ { "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" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" } ], "related": "", "response": [ - {}, { - "description": "ncc_ip", - "name": "ipaddress", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "num_retries", - "name": "numretries", + "description": "id", + "name": "id", "type": "string" }, + {}, { "description": "uuid", "name": "uuid", "type": "string" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "ncc_ip", + "name": "ipaddress", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "num_retries", + "name": "numretries", "type": "string" }, - {}, { - "description": "id", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -31476,25 +31648,16 @@ "name": "resizeVolume", "params": [ { - "description": "Flag to allow automatic migration of the volume to another suitable storage pool that accommodates the new size", + "description": "New minimum number of IOPS", "length": 255, - "name": "automigrate", + "name": "miniops", "required": false, - "since": "4.20.1", - "type": "boolean" - }, - { - "description": "the ID of the disk volume", - "length": 255, - "name": "id", - "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,resizeVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", - "required": true, - "type": "uuid" + "type": "long" }, { - "description": "New minimum number of IOPS", + "description": "New maximum number of IOPS", "length": 255, - "name": "miniops", + "name": "maxiops", "required": false, "type": "long" }, @@ -31506,18 +31669,19 @@ "type": "boolean" }, { - "description": "New maximum 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": "maxiops", + "name": "automigrate", "required": false, - "type": "long" + "since": "4.20.1", + "type": "boolean" }, { - "description": "new disk offering id", + "description": "the ID of the disk volume", "length": 255, - "name": "diskofferingid", - "related": "createDiskOffering,listDiskOfferings", - "required": false, + "name": "id", + "related": "importVolume,attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,resizeVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", + "required": true, "type": "uuid" }, { @@ -31526,23 +31690,53 @@ "name": "size", "required": false, "type": "long" + }, + { + "description": "new disk offering id", + "length": 255, + "name": "diskofferingid", + "related": "createDiskOffering,listDiskOfferings", + "required": false, + "type": "uuid" } ], - "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", + "related": "importVolume,attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", "response": [ { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" }, + {}, { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", - "type": "long" + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", + "type": "string" }, { - "description": "the status of the volume", - "name": "status", + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" + }, + { + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", + "type": "boolean" + }, + { + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", + "type": "string" + }, + { + "description": "state of the virtual machine", + "name": "vmstate", + "type": "string" + }, + {}, + { + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { @@ -31551,18 +31745,18 @@ "type": "boolean" }, { - "description": "the path of the volume", - "name": "path", + "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": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", "type": "string" }, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { @@ -31571,29 +31765,29 @@ "type": "long" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "pod id of the volume", + "name": "podid", "type": "string" }, { - "description": "min iops of the disk volume", - "name": "miniops", - "type": "long" + "description": "details for the volume repair result, they may vary for different hypervisors", + "name": "volumerepairresult", + "type": "map" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, { - "description": "ID of the disk volume", - "name": "id", - "type": "string" + "description": "the bytes allocated", + "name": "virtualsize", + "type": "long" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", - "type": "string" + "description": "min iops of the disk volume", + "name": "miniops", + "type": "long" }, { "description": "the project name of the vpn", @@ -31601,104 +31795,108 @@ "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the disk utilization", + "name": "utilization", + "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "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": "display name of the virtual machine", + "name": "vmdisplayname", + "type": "string" }, - {}, { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" + "description": "the path of the volume", + "name": "path", + "type": "string" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", + "description": "the read (IO) of disk on the vm", + "name": "diskioread", "type": "long" }, { - "description": "ID of the availability zone", - "name": "zoneid", - "type": "string" + "description": "true if volume has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + { + "description": "the date the disk volume was created", + "name": "created", + "type": "date" }, { - "description": "name of the disk volume", - "name": "name", + "description": "the format of the disk encryption if applicable", + "name": "encryptformat", "type": "string" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "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": "name of the disk offering", - "name": "diskofferingname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "path of the Domain the disk volume belongs to", - "name": "domainpath", + "description": "name of the virtual machine", + "name": "vmname", "type": "string" }, { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", + "description": "pod name of the volume", + "name": "podname", "type": "string" }, { - "description": "name of the availability zone", - "name": "zonename", - "type": "string" + "description": "details for the volume check result, they may vary for different hypervisors", + "name": "volumecheckresult", + "type": "map" }, { - "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", - "name": "deviceid", - "type": "long" + "description": "shared or local storage", + "name": "storagetype", + "type": "string" }, { - "description": "the format of the disk encryption if applicable", - "name": "encryptformat", + "description": "the chain info of the volume", + "name": "chaininfo", "type": "string" }, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", + "description": "ID of the availability zone", + "name": "zoneid", "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" }, { @@ -31707,58 +31905,48 @@ "type": "long" }, { - "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": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" - }, - { - "description": "shared or local storage", - "name": "storagetype", + "description": "type of the virtual machine", + "name": "vmtype", "type": "string" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", - "type": "string" + "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": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", + "type": "long" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the status of the volume", + "name": "status", "type": "string" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": "name of the disk volume", + "name": "name", "type": "string" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", - "type": "long" - }, - { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", - "type": "long" + "description": "the state of the disk volume", + "name": "state", + "type": "string" }, { - "description": "the disk utilization", - "name": "utilization", + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "type": "string" }, { @@ -31767,59 +31955,84 @@ "type": "boolean" }, { - "description": "cluster id of the volume", - "name": "clusterid", + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "the account associated with the disk volume", - "name": "account", + "description": "id of the virtual machine", + "name": "virtualmachineid", "type": "string" }, { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "path of the Domain the disk volume belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "type": "long" + }, + { + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "type of the virtual machine", - "name": "vmtype", + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "type": "long" + }, + { + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, { - "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": "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": "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": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "description": "size of the disk volume", + "name": "size", + "type": "long" + }, + { + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, { "description": "the list of resource tags associated", "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", @@ -31840,29 +32053,19 @@ "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", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -31874,84 +32077,53 @@ "type": "set" }, { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", - "type": "long" - }, - { - "description": "the bytes allocated", - "name": "virtualsize", - "type": "long" - }, - {}, - { - "description": "pod name of the volume", - "name": "podname", - "type": "string" - }, - { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "size of the disk volume", - "name": "size", + "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 chain info of the volume", - "name": "chaininfo", - "type": "string" - }, - { - "description": "name of the virtual machine", - "name": "vmname", + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", "type": "string" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", - "type": "string" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "true if volume has delete protection.", - "name": "deleteprotection", + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", "type": "boolean" }, { - "description": "state of the virtual machine", - "name": "vmstate", + "description": "ID of the disk volume", + "name": "id", "type": "string" }, { - "description": "pod id of the volume", - "name": "podid", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "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 write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", + "type": "long" }, { - "description": "the state of the disk volume", - "name": "state", + "description": "cluster name where the volume is allocated", + "name": "clustername", "type": "string" } ] @@ -31962,11 +32134,12 @@ "name": "deleteAffinityGroup", "params": [ { - "description": "The name of the affinity group. Mutually exclusive with ID parameter", + "description": "the project of the affinity group", "length": 255, - "name": "name", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, - "type": "string" + "type": "uuid" }, { "description": "The ID of the affinity group. Mutually exclusive with name parameter", @@ -31985,44 +32158,43 @@ "type": "uuid" }, { - "description": "the account of the affinity group. Must be specified with domain ID", + "description": "The name of the affinity group. Mutually exclusive with ID parameter", "length": 255, - "name": "account", + "name": "name", "required": false, "type": "string" }, { - "description": "the project of the affinity group", + "description": "the account of the affinity group. Must be specified with domain ID", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "account", "required": false, - "type": "uuid" + "type": "string" } ], "response": [ + {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - { - "description": "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" + } ] }, { @@ -32031,40 +32203,40 @@ "name": "addNsxController", "params": [ { - "description": "Username to log into NSX controller", + "description": "Tier-0 Gateway address", "length": 255, - "name": "username", + "name": "tier0gateway", "required": true, "type": "string" }, { - "description": "Edge Cluster name", + "description": "Username to log into NSX controller", "length": 255, - "name": "edgecluster", + "name": "username", "required": true, "type": "string" }, { - "description": "NSX controller port", + "description": "the ID of zone", "length": 255, - "name": "nsxproviderport", - "required": false, - "type": "string" + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": true, + "type": "uuid" }, { - "description": "Password to login into NSX controller", + "description": "NSX controller / provider name", "length": 255, - "name": "password", + "name": "name", "required": true, "type": "string" }, { - "description": "the ID of zone", + "description": "Password to login into NSX controller", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "password", "required": true, - "type": "uuid" + "type": "string" }, { "description": "NSX controller hostname / IP address", @@ -32074,17 +32246,17 @@ "type": "string" }, { - "description": "Tier-0 Gateway address", + "description": "Edge Cluster name", "length": 255, - "name": "tier0gateway", + "name": "edgecluster", "required": true, "type": "string" }, { - "description": "NSX controller / provider name", + "description": "NSX controller port", "length": 255, - "name": "name", - "required": true, + "name": "nsxproviderport", + "required": false, "type": "string" }, { @@ -32098,23 +32270,24 @@ "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 name", + "name": "name", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Zone name to which the NSX controller is associated with", + "name": "zonename", "type": "string" }, { - "description": "NSX controller name", - "name": "name", + "description": "NSX controller port", + "name": "port", "type": "string" }, { - "description": "NSX controller port", - "name": "port", + "description": "Zone ID to which the NSX controller is associated with", + "name": "zoneid", "type": "string" }, { @@ -32122,10 +32295,9 @@ "name": "edgecluster", "type": "string" }, - {}, { - "description": "NSX controller ID", - "name": "nsxprovideruuid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -32134,25 +32306,25 @@ "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 hostname or IP address", + "name": "hostname", "type": "string" }, - {}, { - "description": "NSX controller hostname or IP address", - "name": "hostname", + "description": "NSX controller ID", + "name": "nsxprovideruuid", "type": "string" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" + }, + {}, + { + "description": "The tier-0 gateway network. Tier-0 gateway is responsible for handling traffic between logical and physical networks", + "name": "tier0gateway", + "type": "string" } ], "since": "4.19.0" @@ -32172,10 +32344,71 @@ } ], "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" + } + ], + "since": "3.0.0" + }, + { + "description": "Dedicates a Pod.", + "isasync": true, + "name": "dedicatePod", + "params": [ + { + "description": "the ID of the Pod", + "length": 255, + "name": "podid", + "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", + "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 containing domain", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "required": true, + "type": "uuid" + } + ], + "related": "listDedicatedPods", + "response": [ + { + "description": "the Account Id to which the Pod is dedicated", + "name": "accountid", + "type": "string" + }, + { + "description": "the domain ID to which the Pod is dedicated", + "name": "domainid", + "type": "string" }, {}, { @@ -32184,8 +32417,8 @@ "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the ID of the Pod", + "name": "podid", "type": "string" }, { @@ -32193,9 +32426,23 @@ "name": "jobstatus", "type": "integer" }, + { + "description": "the Name of the Pod", + "name": "podname", + "type": "string" + }, + { + "description": "the ID of the dedicated resource", + "name": "id", + "type": "string" + }, + { + "description": "the Dedication Affinity Group ID of the pod", + "name": "affinitygroupid", + "type": "string" + }, {} - ], - "since": "3.0.0" + ] }, { "description": "Update a Storage network IP range, only allowed when no IPs in this range have been allocated.", @@ -32211,9 +32458,9 @@ "type": "uuid" }, { - "description": "the ending IP address", + "description": "the netmask for storage network", "length": 255, - "name": "endip", + "name": "netmask", "required": false, "type": "string" }, @@ -32225,42 +32472,27 @@ "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": "Optional. the vlan the ip range sits on", "length": 255, - "name": "netmask", + "name": "vlan", "required": false, - "type": "string" + "type": "integer" } ], "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", - "type": "string" - }, { "description": "the network uuid of storage network IP range", "name": "networkid", "type": "string" }, - { - "description": "the netmask of the storage network IP range", - "name": "netmask", - "type": "string" - }, {}, { "description": "the ID or VID of the VLAN.", @@ -32268,78 +32500,38 @@ "type": "integer" }, { - "description": "the Zone uuid of the storage network IP range", - "name": "zoneid", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { "description": "the start ip of the storage network IP range", "name": "startip", "type": "string" }, { - "description": "the uuid of storage network IP range.", - "name": "id", + "description": "the netmask of the storage network IP range", + "name": "netmask", "type": "string" }, { - "description": "the end ip of the storage network IP range", - "name": "endip", + "description": "the Zone uuid of the storage network IP range", + "name": "zoneid", "type": "string" }, { "description": "the Pod uuid for the storage network IP range", "name": "podid", "type": "string" - } - ], - "since": "3.0.0" - }, - { - "description": "Dedicates a Pod.", - "isasync": true, - "name": "dedicatePod", - "params": [ - { - "description": "the ID of the containing domain", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", - "required": true, - "type": "uuid" - }, - { - "description": "the ID of the Pod", - "length": 255, - "name": "podid", - "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", - "required": true, - "type": "uuid" }, { - "description": "the name of the account which needs dedication. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, + "description": "the end ip of the storage network IP range", + "name": "endip", "type": "string" - } - ], - "related": "listDedicatedPods", - "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" }, { - "description": "the Dedication Affinity Group ID of the pod", - "name": "affinitygroupid", + "description": "the gateway of the storage network IP range", + "name": "gateway", "type": "string" }, { @@ -32347,34 +32539,14 @@ "name": "jobid", "type": "string" }, - {}, - {}, { - "description": "the ID of the dedicated resource", + "description": "the uuid of storage network IP range.", "name": "id", "type": "string" }, - { - "description": "the Account Id to which the Pod is dedicated", - "name": "accountid", - "type": "string" - }, - { - "description": "the Name of the Pod", - "name": "podname", - "type": "string" - }, - { - "description": "the ID of the Pod", - "name": "podid", - "type": "string" - }, - { - "description": "the domain ID to which the Pod is dedicated", - "name": "domainid", - "type": "string" - } - ] + {} + ], + "since": "3.0.0" }, { "description": "Creates a GPU card definition in the system", @@ -32382,11 +32554,11 @@ "name": "createGpuCard", "params": [ { - "description": "the display name of the GPU card", + "description": "the video RAM size in MB for the passthrough vGPU profile", "length": 255, - "name": "name", - "required": true, - "type": "string" + "name": "videoram", + "required": false, + "type": "long" }, { "description": "the device name of the GPU card", @@ -32396,18 +32568,18 @@ "type": "string" }, { - "description": "the device ID of the GPU card", + "description": "the display name of the GPU card", "length": 255, - "name": "deviceid", + "name": "name", "required": true, "type": "string" }, { - "description": "the video RAM size in MB for the passthrough vGPU profile", + "description": "the vendor ID of the GPU card", "length": 255, - "name": "videoram", - "required": false, - "type": "long" + "name": "vendorid", + "required": true, + "type": "string" }, { "description": "the vendor name of the GPU card", @@ -32417,15 +32589,26 @@ "type": "string" }, { - "description": "the vendor ID of the GPU card", + "description": "the device ID of the GPU card", "length": 255, - "name": "vendorid", + "name": "deviceid", "required": true, "type": "string" } ], "related": "updateGpuCard,listGpuCards", "response": [ + { + "description": "the device ID of the GPU card", + "name": "deviceid", + "type": "string" + }, + {}, + { + "description": "the vendor name of the GPU card", + "name": "vendorname", + "type": "string" + }, { "description": "the device name of the GPU card", "name": "devicename", @@ -32438,13 +32621,8 @@ }, {}, { - "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" }, { @@ -32452,21 +32630,15 @@ "name": "jobstatus", "type": "integer" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the vendor ID of the GPU card", + "name": "vendorid", "type": "string" }, { "description": "the ID of the GPU card", "name": "id", "type": "string" - }, - { - "description": "the vendor ID of the GPU card", - "name": "vendorid", - "type": "string" } ], "since": "4.21.0" @@ -32486,27 +32658,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": "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" } ] }, @@ -32516,12 +32688,11 @@ "name": "listVgpuProfiles", "params": [ { - "description": "ID of the vGPU profile", + "description": "", "length": 255, - "name": "id", - "related": "createVgpuProfile,updateVgpuProfile,listVgpuProfiles", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { "description": "List by keyword", @@ -32545,17 +32716,10 @@ "type": "integer" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "the GPU card ID associated with this GPU device", + "description": "ID of the vGPU profile", "length": 255, - "name": "gpucardid", - "related": "updateGpuCard,listGpuCards", + "name": "id", + "related": "createVgpuProfile,updateVgpuProfile,listVgpuProfiles", "required": false, "type": "uuid" }, @@ -32565,20 +32729,22 @@ "name": "name", "required": false, "type": "string" + }, + { + "description": "the GPU card ID associated with this GPU device", + "length": 255, + "name": "gpucardid", + "related": "updateGpuCard,listGpuCards", + "required": false, + "type": "uuid" } ], "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 display heads", + "name": "maxheads", "type": "long" }, { @@ -32587,9 +32753,9 @@ "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the video RAM size in MB", + "name": "videoram", + "type": "long" }, { "description": "the ID of the GPU card", @@ -32597,59 +32763,65 @@ "type": "string" }, { - "description": "the vendor name of the GPU card", - "name": "vendorname", + "description": "the name of the vGPU profile", + "name": "gpucardname", "type": "string" }, { - "description": "the description of the vGPU profile", - "name": "description", - "type": "string" + "description": "the maximum X resolution", + "name": "maxresolutionx", + "type": "long" }, { - "description": "the device ID of the GPU card", - "name": "deviceid", + "description": "the vendor ID of the GPU card", + "name": "vendorid", "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 associated with this vGPU profile", - "name": "gpucardid", + "description": "the maximum number of vGPUs per physical GPU", + "name": "maxvgpuperphysicalgpu", + "type": "long" + }, + { + "description": "the device name of the GPU card", + "name": "devicename", "type": "string" }, { - "description": "the display name of the GPU card", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the video RAM size in MB", - "name": "videoram", - "type": "long" + "description": "the device ID of the GPU card", + "name": "deviceid", + "type": "string" }, { - "description": "the device name of the GPU card", - "name": "devicename", + "description": "the ID of the GPU card associated with this vGPU profile", + "name": "gpucardid", "type": "string" }, { - "description": "the maximum number of vGPUs per physical GPU", - "name": "maxvgpuperphysicalgpu", + "description": "the maximum Y resolution", + "name": "maxresolutiony", "type": "long" }, { - "description": "the maximum number of display heads", - "name": "maxheads", - "type": "long" + "description": "the description of the vGPU profile", + "name": "description", + "type": "string" }, + {}, { - "description": "the maximum X resolution", - "name": "maxresolutionx", - "type": "long" + "description": "the display name of the GPU card", + "name": "name", + "type": "string" } ], "since": "4.21.0" @@ -32660,57 +32832,57 @@ "name": "purgeExpungedResources", "params": [ { - "description": "The size of batch used during purging", + "description": "The type of the resource which need to be purged. Supported types: VirtualMachine", "length": 255, - "name": "batchsize", + "name": "resourcetype", "required": false, - "type": "long" + "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\")", + "description": "The start date range of the expunged resources used for purging (use format \"yyyy-MM-dd\" or \"yyyy-MM-dd HH:mm:ss\")", "length": 255, - "name": "enddate", + "name": "startdate", "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\")", + "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": "startdate", + "name": "enddate", "required": false, "type": "date" }, { - "description": "The type of the resource which need to be purged. Supported types: VirtualMachine", + "description": "The size of batch used during purging", "length": 255, - "name": "resourcetype", + "name": "batchsize", "required": false, - "type": "string" + "type": "long" } ], "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": "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" }, @@ -32720,16 +32892,9 @@ "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" }, @@ -32745,10 +32910,24 @@ "description": "the ID of the volume", "length": 255, "name": "id", - "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", + "related": "importVolume,attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", "required": true, "type": "uuid" }, + { + "description": "Verify OK to Shrink", + "length": 255, + "name": "shrinkok", + "required": false, + "type": "boolean" + }, + { + "description": "New volume size in GB for the custom disk offering", + "length": 255, + "name": "size", + "required": false, + "type": "long" + }, { "description": "New maximum number of IOPS for the custom disk offering", "length": 255, @@ -32762,130 +32941,103 @@ "name": "automigrate", "required": false, "type": "boolean" - }, - { - "description": "New minimum number of IOPS for the custom disk offering", - "length": 255, - "name": "miniops", - "required": false, - "type": "long" } ], - "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", + "related": "importVolume,attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", "response": [ { - "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": "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": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, { - "description": "state of the virtual machine", - "name": "vmstate", + "description": "type of the virtual machine", + "name": "vmtype", "type": "string" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", + "description": "the state of the disk volume", + "name": "state", "type": "string" }, { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", - "type": "long" + "description": "details for the volume repair result, they may vary for different hypervisors", + "name": "volumerepairresult", + "type": "map" }, { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", "type": "boolean" }, { - "description": "the chain info of the volume", - "name": "chaininfo", - "type": "string" - }, - { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", - "type": "string" - }, - { - "description": "the bytes actually consumed on disk", - "name": "physicalsize", + "description": "the bytes allocated", + "name": "virtualsize", "type": "long" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" + "description": "cluster id of the volume", + "name": "clusterid", + "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "the project name of the vpn", + "name": "project", + "type": "string" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "description": "the chain info of the volume", + "name": "chaininfo", "type": "string" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "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": "details for the volume check result, they may vary for different hypervisors", - "name": "volumecheckresult", - "type": "map" + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", "type": "string" }, { - "description": "the disk utilization", - "name": "utilization", + "description": "the path of the volume", + "name": "path", "type": "string" }, { - "description": "name of the disk volume", - "name": "name", + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, { - "description": "the bytes allocated", - "name": "virtualsize", + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", "type": "long" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" }, { @@ -32893,198 +33045,208 @@ "name": "tags", "response": [ { - "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": "tag key name", - "name": "key", + "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": "customer associated with the tag", - "name": "customer", + "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": "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 name where tag belongs to", + "name": "project", "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": "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" } ], "type": "set" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", "type": "string" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "name of the disk volume", + "name": "name", + "type": "string" + }, + { + "description": "the date the disk volume was created", + "name": "created", + "type": "date" + }, + { + "description": "id of the virtual machine", + "name": "virtualmachineid", "type": "string" }, - {}, { "description": "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": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "type": "string" }, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "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": "shared or local storage", - "name": "storagetype", + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, + {}, + { + "description": "details for the volume check result, they may vary for different hypervisors", + "name": "volumecheckresult", + "type": "map" + }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "name of the virtual machine", + "name": "vmname", "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": "the date the disk volume was created", - "name": "created", - "type": "date" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "ID of the disk volume", - "name": "id", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "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": "type of the virtual machine", - "name": "vmtype", + "description": "shared or local storage", + "name": "storagetype", "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": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "pod name of the volume", + "name": "podname", "type": "string" }, { - "description": "name of the virtual machine", - "name": "vmname", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", - "type": "string" + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" }, { - "description": "name of the disk offering", - "name": "diskofferingname", - "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": "the format of the disk encryption if applicable", + "name": "encryptformat", "type": "string" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "ID of the disk volume", + "name": "id", "type": "string" }, { - "description": "the path of the volume", - "name": "path", + "description": "cluster name where the volume is allocated", + "name": "clustername", "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": "details for the volume repair result, they may vary for different hypervisors", - "name": "volumerepairresult", - "type": "map" - }, - { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" - }, {}, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", - "type": "boolean" + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" }, { - "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", - "name": "deviceid", + "description": "max iops of the disk volume", + "name": "maxiops", "type": "long" }, { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" }, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", "type": "boolean" }, { @@ -33093,18 +33255,18 @@ "type": "string" }, { - "description": "min iops of the disk volume", - "name": "miniops", + "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": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "state of the virtual machine", + "name": "vmstate", "type": "string" }, { @@ -33113,89 +33275,99 @@ "type": "long" }, { - "description": "pod name of the volume", - "name": "podname", + "description": "the status of the volume", + "name": "status", "type": "string" }, { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, { - "description": "pod id of the volume", - "name": "podid", - "type": "string" + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "type": "long" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "cluster id of the volume", - "name": "clusterid", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { - "description": "max iops of the disk volume", - "name": "maxiops", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, { - "description": "the format of the disk encryption if applicable", - "name": "encryptformat", + "description": "name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", - "type": "string" + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" }, { - "description": "size of the disk volume", - "name": "size", - "type": "long" + "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": "name of the availability zone", + "name": "zonename", + "type": "string" }, { - "description": "the state of the disk volume", - "name": "state", + "description": "pod id of the volume", + "name": "podid", "type": "string" }, { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", + "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 display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "description": "the bytes actually consumed on disk", + "name": "physicalsize", + "type": "long" + }, + { + "description": "the disk utilization", + "name": "utilization", "type": "string" }, { - "description": "path of the Domain the disk volume belongs to", - "name": "domainpath", + "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 volume has delete protection.", - "name": "deleteprotection", + "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", + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, { - "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": "display name of the virtual machine", + "name": "vmdisplayname", + "type": "string" } ], "since": "4.17" @@ -33206,19 +33378,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,6 +33399,13 @@ "name": "port", "required": false, "type": "integer" + }, + { + "description": "Hostname", + "length": 255, + "name": "hostname", + "required": false, + "type": "string" } ], "related": "addLdapConfiguration,listLdapConfigurations", @@ -33241,6 +33421,16 @@ "name": "jobstatus", "type": "integer" }, + { + "description": "the ID of the LDAP configuration", + "name": "id", + "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", @@ -33251,11 +33441,6 @@ "name": "hostname", "type": "string" }, - { - "description": "port the ldap server is running on", - "name": "port", - "type": "int" - }, {} ], "since": "4.2.0" @@ -33266,11 +33451,12 @@ "name": "createProjectRole", "params": [ { - "description": "creates a project role with this unique name", + "description": "ID of project where role is being created", "length": 255, - "name": "name", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": true, - "type": "string" + "type": "uuid" }, { "description": "The description of the Project role", @@ -33280,12 +33466,11 @@ "type": "string" }, { - "description": "ID of project where role is being created", + "description": "creates a project role with this unique name", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "name", "required": true, - "type": "uuid" + "type": "string" } ], "related": "listProjectRoles,updateProjectRole", @@ -33301,6 +33486,17 @@ "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 name of the role", "name": "name", @@ -33311,21 +33507,10 @@ "name": "description", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "the id of the project", "name": "projectid", "type": "string" - }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" } ], "since": "4.15.0" @@ -33336,37 +33521,37 @@ "name": "createIpv6FirewallRule", "params": [ { - "description": "the destination CIDR list to allow traffic to. Multiple entries must be separated by a single comma character (,).", + "description": "the ending port of Ipv6 firewall rule", "length": 255, - "name": "destcidrlist", + "name": "endport", "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": "type of the ICMP message being sent", "length": 255, - "name": "cidrlist", + "name": "icmptype", "required": false, - "type": "list" + "type": "integer" }, { - "description": "the traffic type for the Ipv6 firewall rule, can be ingress or egress, defaulted to ingress if not specified", + "description": "the destination CIDR list to allow traffic to. Multiple entries must be separated by a single comma character (,).", "length": 255, - "name": "traffictype", + "name": "destcidrlist", "required": false, - "type": "string" + "type": "list" }, { - "description": "type of the ICMP message being sent", + "description": "the traffic type for the Ipv6 firewall rule, can be ingress or egress, defaulted to ingress if not specified", "length": 255, - "name": "icmptype", + "name": "traffictype", "required": false, - "type": "integer" + "type": "string" }, { - "description": "the ending port of Ipv6 firewall rule", + "description": "the starting port of Ipv6 firewall rule", "length": 255, - "name": "endport", + "name": "startport", "required": false, "type": "integer" }, @@ -33378,11 +33563,11 @@ "type": "string" }, { - "description": "error code for this ICMP message", + "description": "the source CIDR list to allow traffic from. Multiple entries must be separated by a single comma character (,).", "length": 255, - "name": "icmpcode", + "name": "cidrlist", "required": false, - "type": "integer" + "type": "list" }, { "description": "an optional field, whether to the display the rule to the end user or not", @@ -33392,9 +33577,9 @@ "type": "boolean" }, { - "description": "the starting port of Ipv6 firewall rule", + "description": "error code for this ICMP message", "length": 255, - "name": "startport", + "name": "icmpcode", "required": false, "type": "integer" }, @@ -33407,35 +33592,97 @@ "type": "uuid" } ], - "related": "createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,updateIpv6FirewallRule", + "related": "createRoutingFirewallRule,listRoutingFirewallRules,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule", "response": [ + {}, { - "description": "the ending port of port forwarding rule's private port range", - "name": "privateendport", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the vm ip address for the port forwarding rule", + "name": "vmguestip", "type": "string" }, { - "description": "the protocol of the port forwarding rule", - "name": "protocol", + "description": "the starting port of port forwarding rule's private port range", + "name": "privateport", "type": "string" }, + {}, { - "description": "the starting port of port forwarding rule's public port range", - "name": "publicport", + "description": "the VM name for the port forwarding rule", + "name": "virtualmachinename", "type": "string" }, + { + "description": "the VM ID for the port forwarding rule", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "is firewall for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, { "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 protocol of the port forwarding rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the VM display name for the port forwarding rule", + "name": "virtualmachinedisplayname", + "type": "string" + }, + { + "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", + "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": "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 ending port of port forwarding rule's private port range", + "name": "privateendport", + "type": "string" + }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "the account associated with the tag", - "name": "account", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -33444,18 +33691,23 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "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 name where tag belongs to", + "name": "project", "type": "string" }, { @@ -33464,8 +33716,8 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -33474,95 +33726,28 @@ "type": "string" }, { - "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 project id the tag belongs to", - "name": "projectid", + "description": "tag value", + "name": "value", "type": "string" } ], "type": "list" }, { - "description": "the id of the guest network the port forwarding rule belongs to", - "name": "networkid", - "type": "string" - }, - { - "description": "is firewall for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the ID of the port forwarding rule", - "name": "id", - "type": "string" - }, - { - "description": "the VM ID for the port forwarding rule", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the vm ip address for the port forwarding rule", - "name": "vmguestip", - "type": "string" - }, - { - "description": "the starting port of port forwarding rule's private port range", - "name": "privateport", - "type": "string" - }, - { - "description": "the VM name for the port forwarding rule", - "name": "virtualmachinename", - "type": "string" - }, - { - "description": "the VM display name for the port forwarding rule", - "name": "virtualmachinedisplayname", - "type": "string" - }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the public ip address id for the port forwarding rule", - "name": "ipaddressid", + "description": "the starting port of port forwarding rule's public port range", + "name": "publicport", "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,16 +33766,6 @@ ], "related": "prepareForMaintenance,cancelMaintenance,prepareForShutdown,cancelShutdown,readyForShutdown", "response": [ - { - "description": "the state of the management server", - "name": "state", - "type": "state" - }, - { - "description": "The number of host agents this management server is responsible for", - "name": "agentscount", - "type": "long" - }, { "description": "The host agents this management server is responsible for", "name": "agents", @@ -33601,37 +33776,47 @@ "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 a shutdown has been triggered", + "name": "shutdowntriggered", + "type": "boolean" }, + {}, + {}, { "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 state of the management server", + "name": "state", + "type": "state" + }, { "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 UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, - {}, { "description": "The number of jobs in progress", "name": "pendingjobscount", "type": "long" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ], "since": "4.19.0" @@ -33642,19 +33827,19 @@ "name": "updateNetwork", "params": [ { - "description": "MTU to be configured on the network VR's public facing interfaces", + "description": "the new display text for the network", "length": 255, - "name": "privatemtu", + "name": "displaytext", "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", + "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": "updateinsequence", + "name": "dns1", "required": false, - "type": "boolean" + "since": "4.18.0", + "type": "string" }, { "description": "the new name for the network", @@ -33664,18 +33849,28 @@ "type": "string" }, { - "description": "Setting this to true will cause a forced network update,", + "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": "forced", + "name": "ip6dns1", "required": false, - "type": "boolean" + "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. Empty string will update the second IPv6 DNS with the value from the zone", "length": 255, - "name": "hideipaddressusage", + "name": "ip6dns2", "required": false, - "type": "boolean" + "since": "4.18.0", + "type": "string" + }, + { + "description": "network offering ID", + "length": 255, + "name": "networkofferingid", + "related": "createNetworkOffering,updateNetworkOffering,listNetworkOfferings", + "required": false, + "type": "uuid" }, { "description": "an optional field, whether to the display the network to the end user or not.", @@ -33693,78 +33888,61 @@ "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" - }, - { - "description": "the first IPv6 DNS for the network. Empty string will update the first IPv6 DNS with the value from the zone", + "description": "MTU to be configured on the network VR's public facing interfaces", "length": 255, - "name": "ip6dns1", + "name": "privatemtu", "required": false, "since": "4.18.0", - "type": "string" - }, - { - "description": "CIDR for guest VMs, CloudStack allocates IPs to guest VMs only from this CIDR", - "length": 255, - "name": "guestvmcidr", - "required": false, - "type": "string" + "type": "integer" }, { - "description": "the second IPv4 DNS for the network. Empty string will update the second IPv4 DNS with the value from the zone", + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "dns2", + "name": "customid", "required": false, - "since": "4.18.0", + "since": "4.4", "type": "string" }, { - "description": "the new display text for the network", + "description": "Force update even if CIDR type is different", "length": 255, - "name": "displaytext", + "name": "changecidr", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "the second IPv6 DNS for the network. Empty string will update the second IPv6 DNS with the value from the zone", + "description": "network domain", "length": 255, - "name": "ip6dns2", + "name": "networkdomain", "required": false, - "since": "4.18.0", "type": "string" }, { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "description": "Setting this to true will cause a forced network update,", "length": 255, - "name": "customid", + "name": "forced", "required": false, - "since": "4.4", - "type": "string" + "type": "boolean" }, { - "description": "the first IPv4 DNS for the network. Empty string will update the first IPv4 DNS with the value from the zone", + "description": "the second IPv4 DNS for the network. Empty string will update the second IPv4 DNS with the value from the zone", "length": 255, - "name": "dns1", + "name": "dns2", "required": false, "since": "4.18.0", "type": "string" }, { - "description": "network domain", + "description": "when true ip address usage for the network will not be exported by the listUsageRecords API", "length": 255, - "name": "networkdomain", + "name": "hideipaddressusage", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "Force update even if CIDR type is different", + "description": "if true, we will update the routers one after the other. applicable only for redundant router based networks using virtual router as provider", "length": 255, - "name": "changecidr", + "name": "updateinsequence", "required": false, "type": "boolean" }, @@ -33777,39 +33955,118 @@ "type": "string" }, { - "description": "network offering ID", + "description": "the ID of the network", "length": 255, - "name": "networkofferingid", - "related": "createNetworkOffering,updateNetworkOffering,listNetworkOfferings", - "required": false, + "name": "id", + "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "required": true, "type": "uuid" + }, + { + "description": "CIDR for guest VMs, CloudStack allocates IPs to guest VMs only from this CIDR", + "length": 255, + "name": "guestvmcidr", + "required": false, + "type": "string" } ], "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "response": [ { - "description": "the project name of the address", - "name": "project", + "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": "tag value", + "name": "value", + "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": "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": "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": "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 ID of the Network associated with this private gateway", + "name": "associatednetworkid", "type": "string" }, { - "description": "UUID of AS NUMBER", - "name": "asnumberid", + "description": "state of the network", + "name": "state", "type": "string" }, { - "description": "if network offering supports vm autoscaling feature", - "name": "supportsvmautoscaling", - "type": "boolean" + "description": "availability of the network offering the network is created from", + "name": "networkofferingavailability", + "type": "string" }, { - "description": "the first IPv6 DNS for the network", - "name": "ip6dns1", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the network's netmask", - "name": "netmask", + "description": "the displaytext of the network", + "name": "displaytext", "type": "string" }, { @@ -33818,136 +34075,189 @@ "type": "string" }, { - "description": "zone id of the network", - "name": "zoneid", + "description": "display text of the network offering the network is created from", + "name": "networkofferingdisplaytext", "type": "string" }, { - "description": "true if network supports specifying vlan, false otherwise", - "name": "specifyvlan", - "type": "boolean" + "description": "Broadcast domain type of the network", + "name": "broadcastdomaintype", + "type": "string" }, - {}, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the first IPv4 DNS for the network", + "name": "dns1", + "type": "string" }, { - "description": "Name of the VPC to which this network belongs", - "name": "vpcname", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { - "description": "The vlan of the network. This parameter is visible to ROOT admins only", - "name": "vlan", - "type": "string" + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip4routes", + "type": "set" }, { - "description": "the details of the network", - "name": "details", - "type": "map" + "description": "true network requires restart", + "name": "restartrequired", + "type": "boolean" }, { - "description": "The internet protocol of network offering", - "name": "internetprotocol", + "description": "the second IPv4 DNS for the network", + "name": "dns2", "type": "string" }, { - "description": "the traffic type of the network", - "name": "traffictype", + "description": "the physical network id", + "name": "physicalnetworkid", "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": "list networks that are persistent", + "name": "ispersistent", + "type": "boolean" + }, + { + "description": "an optional field, whether to the display the network to the end user or not.", + "name": "displaynetwork", + "type": "boolean" + }, + { + "description": "UUID of AS NUMBER", + "name": "asnumberid", "type": "string" }, { - "description": "display text of the network offering the network is created from", - "name": "networkofferingdisplaytext", + "description": "the domain name of the network owner", + "name": "domain", "type": "string" }, { - "description": "ACL name associated with the VPC network", - "name": "aclname", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "The Ipv6 routing type of network offering", - "name": "ip6routing", + "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": "network offering id the network is created from", - "name": "networkofferingid", + "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", + "name": "broadcasturi", "type": "string" }, { - "description": "ACL Id associated with the VPC network", - "name": "aclid", + "description": "The vlan of the network. This parameter is visible to ROOT admins only", + "name": "vlan", "type": "string" }, { - "description": "MTU configured on the network VR's public facing interfaces", - "name": "publicmtu", - "type": "integer" + "description": "AS NUMBER", + "name": "asnumber", + "type": "long" }, { - "description": "state of the network", - "name": "state", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "list networks available for vm deployment", - "name": "canusefordeploy", + "description": "the name of the Network associated with this private gateway", + "name": "associatednetwork", + "type": "string" + }, + { + "description": "true if network supports specifying vlan, false otherwise", + "name": "specifyvlan", "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": "the project id of the ipaddress", + "name": "projectid", + "type": "string" + }, + { + "description": "true if network supports specifying ip ranges, false otherwise", + "name": "specifyipranges", + "type": "boolean" }, { "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", + "description": "The IPv4 routing type of network", + "name": "ip4routing", + "type": "string" + }, + { + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" + }, + { + "description": "the type of the network", + "name": "type", "type": "string" }, + { + "description": "true if network is system, false otherwise", + "name": "issystem", + "type": "boolean" + }, { "description": "VPC the network belongs to", "name": "vpcid", "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": "AS NUMBER", - "name": "asnumber", - "type": "long" + "description": "MTU configured on the network VR's private interfaces", + "name": "privatemtu", + "type": "integer" }, { - "description": "the owner of the network", - "name": "account", + "description": "the second IPv6 DNS for the network", + "name": "ip6dns2", "type": "string" }, { - "description": "If the network has redundant routers enabled", - "name": "redundantrouter", + "description": "true if users from subdomains can access the domain level network", + "name": "subdomainaccess", "type": "boolean" }, { - "description": "MTU configured on the network VR's private interfaces", - "name": "privatemtu", - "type": "integer" + "description": "network offering id the network is created from", + "name": "networkofferingid", + "type": "string" + }, + { + "description": "the traffic type of the network", + "name": "traffictype", + "type": "string" + }, + { + "description": "the name of the zone the network belongs to", + "name": "zonename", + "type": "string" + }, + { + "description": "the domain id of the network owner", + "name": "domainid", + "type": "string" }, { "description": "the date this network was created", @@ -33955,101 +34265,105 @@ "type": "date" }, { - "description": "the type of the network", - "name": "type", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the list of resource tags associated with network", - "name": "tags", - "response": [ - { - "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" - }, - { - "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": "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": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - } - ], - "type": "list" + "description": "Tungsten-Fabric virtual router the network belongs to", + "name": "tungstenvirtualrouteruuid", + "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 owner of the network", + "name": "account", + "type": "string" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "Name of the VPC to which this network belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "the name of the network", + "name": "name", + "type": "string" + }, + { + "description": "true if network offering is ip conserve mode enabled", + "name": "networkofferingconservemode", + "type": "boolean" + }, + { + "description": "related to what other network configuration", + "name": "related", + "type": "string" + }, + { + "description": "the network's gateway", + "name": "gateway", + "type": "string" + }, + { + "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": "path of the Domain the network belongs to", + "name": "domainpath", "type": "string" }, { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip6routes", + "description": "The BGP peers for the network", + "name": "bgppeers", "type": "set" }, { - "description": "the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE", - "name": "networkcidr", + "description": "true if network is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "true if network can span multiple zones", + "name": "strechedl2subnet", + "type": "boolean" + }, + { + "description": "The external id of the network", + "name": "externalid", "type": "string" }, { - "description": "the domain id of the network owner", - "name": "domainid", + "description": "zone id of the network", + "name": "zoneid", "type": "string" }, { - "description": "Tungsten-Fabric virtual router the network belongs to", - "name": "tungstenvirtualrouteruuid", + "description": "the first IPv6 DNS for the network", + "name": "ip6dns1", "type": "string" }, { - "description": "true if network is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "ACL Id associated with the VPC network", + "name": "aclid", + "type": "string" }, { "description": "the id of the network", @@ -34057,72 +34371,62 @@ "type": "string" }, { - "description": "name of the network offering the network is created from", - "name": "networkofferingname", + "description": "ACL name associated with the VPC network", + "name": "aclname", "type": "string" }, { - "description": "true if network can span multiple zones", - "name": "strechedl2subnet", - "type": "boolean" + "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", + "name": "cidr", + "type": "string" }, { - "description": "The BGP peers for the network", - "name": "bgppeers", - "type": "set" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the displaytext of the network", - "name": "displaytext", + "description": "the network's netmask", + "name": "netmask", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "If the network has redundant routers enabled", + "name": "redundantrouter", + "type": "boolean" }, { - "description": "the ID of the Network associated with this private gateway", - "name": "associatednetworkid", - "type": "string" + "description": "list networks available for vm deployment", + "name": "canusefordeploy", + "type": "boolean" }, { - "description": "the network's gateway", - "name": "gateway", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the first IPv4 DNS for the network", - "name": "dns1", - "type": "string" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "true if users from subdomains can access the domain level network", - "name": "subdomainaccess", + "description": "if network offering supports vm autoscaling feature", + "name": "supportsvmautoscaling", "type": "boolean" }, - { - "description": "the project id of the ipaddress", - "name": "projectid", - "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": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" }, { "description": "the capability value", @@ -34130,9 +34434,9 @@ "type": "string" }, { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" + "description": "the capability name", + "name": "name", + "type": "string" } ], "type": "list" @@ -34147,15 +34451,10 @@ "type": "string" }, { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", + "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 provider name", "name": "name", @@ -34167,151 +34466,37 @@ "type": "list" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", "type": "string" }, { "description": "state of the network provider", "name": "state", "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" } ], "type": "list" }, { - "description": "The IPv4 routing type of network", - "name": "ip4routing", - "type": "string" - }, - { - "description": "the network domain", - "name": "networkdomain", - "type": "string" - }, - { - "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", - "type": "boolean" - }, - { - "description": "true if network is system, false otherwise", - "name": "issystem", - "type": "boolean" - }, - { - "description": "Broadcast domain type of the network", - "name": "broadcastdomaintype", - "type": "string" - }, - { - "description": "list networks that are persistent", - "name": "ispersistent", - "type": "boolean" - }, - { - "description": "path of the Domain the network belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "true network requires restart", - "name": "restartrequired", - "type": "boolean" - }, - { - "description": "the name of the network", - "name": "name", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", - "name": "zonesnetworkspans", - "type": "set" - }, - { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "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": "availability of the network offering the network is created from", - "name": "networkofferingavailability", - "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": "the second IPv6 DNS for the network", - "name": "ip6dns2", - "type": "string" - }, - { - "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "the physical network id", - "name": "physicalnetworkid", - "type": "string" - }, - { - "description": "true if network offering is ip conserve mode enabled", - "name": "networkofferingconservemode", - "type": "boolean" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "the name of the zone the network belongs to", - "name": "zonename", - "type": "string" - }, - { - "description": "the second IPv4 DNS for the network", - "name": "dns2", + "description": "The internet protocol of network offering", + "name": "internetprotocol", "type": "string" }, - { - "description": "related to what other network configuration", - "name": "related", - "type": "string" - } + {} ] }, { @@ -34320,42 +34505,33 @@ "name": "listBackups", "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": "id of the VM", + "description": "list backups by name", "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": "name", "required": false, - "type": "uuid" + "since": "4.21.0", + "type": "string" }, { - "description": "list only resources belonging to the domain specified", + "description": "", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "List by keyword", + "description": "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 backups by name", + "description": "", "length": 255, - "name": "name", + "name": "page", "required": false, - "since": "4.21.0", - "type": "string" + "type": "integer" }, { "description": "list backups with VM details", @@ -34374,26 +34550,27 @@ "type": "uuid" }, { - "description": "", + "description": "id of the VM", "length": 255, - "name": "page", + "name": "virtualmachineid", + "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,createVMFromBackup,createVMFromBackup,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "", + "description": "list backups by zone id", "length": 255, - "name": "pagesize", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "list backups by backup offering", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "backupofferingid", - "related": "listBackupProviderOfferings,importBackupOffering,listBackupOfferings,updateBackupOffering", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, - "since": "4.21.0", "type": "uuid" }, { @@ -34404,39 +34581,62 @@ "type": "boolean" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "list backups by backup offering", "length": 255, - "name": "account", + "name": "backupofferingid", + "related": "listBackupProviderOfferings,importBackupOffering,listBackupOfferings,updateBackupOffering", + "required": false, + "since": "4.21.0", + "type": "uuid" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", "required": false, "type": "string" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "list 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,moveDomain", "required": false, "type": "uuid" }, { - "description": "list backups by zone id", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "account", "required": false, - "type": "uuid" + "type": "string" } ], "related": "updateBackupSchedule", "response": [ { - "description": "description for the backup", - "name": "description", + "description": "Indicates whether the VM from which the backup was taken is expunged or not", + "name": "isbackupvmexpunged", + "type": "boolean" + }, + { + "description": "The backup offering corresponding to this backup was removed from the VM", + "name": "vmbackupofferingremoved", + "type": "boolean" + }, + { + "description": "external backup id", + "name": "externalid", "type": "string" }, { - "description": "ID of the VM", - "name": "virtualmachineid", + "description": "backed up volumes", + "name": "volumes", + "type": "string" + }, + { + "description": "description for the backup", + "name": "description", "type": "string" }, { @@ -34445,23 +34645,23 @@ "type": "long" }, { - "description": "backup type", - "name": "type", + "description": "backup offering id", + "name": "backupofferingid", "type": "string" }, { - "description": "account name", - "name": "account", + "description": "name of the VM", + "name": "virtualmachinename", "type": "string" }, { - "description": "backup protected (virtual) size in bytes", - "name": "virtualsize", - "type": "long" + "description": "backup date", + "name": "created", + "type": "date" }, { - "description": "backup offering name", - "name": "backupofferingname", + "description": "backup type", + "name": "type", "type": "string" }, { @@ -34470,24 +34670,23 @@ "type": "integer" }, { - "description": "domain id", - "name": "domainid", + "description": "ID of the VM", + "name": "virtualmachineid", "type": "string" }, + { + "description": "Lists the vm specific details for the backup", + "name": "vmdetails", + "type": "map" + }, { "description": "Interval type of the backup", "name": "intervaltype", "type": "string" }, { - "description": "backup date", - "name": "created", - "type": "date" - }, - {}, - { - "description": "zone id", - "name": "zoneid", + "description": "domain id", + "name": "domainid", "type": "string" }, { @@ -34496,15 +34695,14 @@ "type": "string" }, { - "description": "backed up volumes", - "name": "volumes", + "description": "name of the backup", + "name": "name", "type": "string" }, - {}, { - "description": "Lists the vm specific details for the backup", - "name": "vmdetails", - "type": "map" + "description": "backup protected (virtual) size in bytes", + "name": "virtualsize", + "type": "long" }, { "description": "backup status", @@ -34512,18 +34710,18 @@ "type": "status" }, { - "description": "domain name", - "name": "domain", + "description": "account id", + "name": "accountid", "type": "string" }, { - "description": "The backup offering corresponding to this backup was removed from the VM", - "name": "vmbackupofferingremoved", - "type": "boolean" + "description": "backup offering name", + "name": "backupofferingname", + "type": "string" }, { - "description": "backup offering id", - "name": "backupofferingid", + "description": "account name", + "name": "account", "type": "string" }, { @@ -34531,31 +34729,23 @@ "name": "jobid", "type": "string" }, + {}, { - "description": "account id", - "name": "accountid", - "type": "string" - }, - { - "description": "name of the VM", - "name": "virtualmachinename", + "description": "domain name", + "name": "domain", "type": "string" }, { - "description": "external backup id", - "name": "externalid", + "description": "zone name", + "name": "zone", "type": "string" }, { - "description": "name of the backup", - "name": "name", + "description": "zone id", + "name": "zoneid", "type": "string" }, - { - "description": "zone name", - "name": "zone", - "type": "string" - } + {} ], "since": "4.14.0" }, @@ -34567,32 +34757,32 @@ "related": "", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Usage type description", + "name": "description", + "type": "string" }, { - "description": "Usage type name", - "name": "name", - "type": "string" + "description": "Usage type ID", + "name": "id", + "type": "integer" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, { - "description": "Usage type ID", - "name": "id", - "type": "integer" - }, - { - "description": "Usage type description", - "name": "description", + "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" + } ] }, { @@ -34610,17 +34800,18 @@ ], "related": "", "response": [ + {}, + {}, { - "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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the CA service provider name", + "name": "name", "type": "string" }, - {}, { "description": "the description of the CA service provider", "name": "description", @@ -34630,8 +34821,7 @@ "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - {} + } ], "since": "4.14.0" }, @@ -34651,15 +34841,21 @@ ], "related": "listNsxControllers", "response": [ + {}, + { + "description": "NSX controller hostname or IP address", + "name": "hostname", + "type": "string" + }, { "description": "NSX controller ID", "name": "nsxprovideruuid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The tier-0 gateway network. Tier-0 gateway is responsible for handling traffic between logical and physical networks", + "name": "tier0gateway", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", @@ -34667,35 +34863,24 @@ "type": "string" }, { - "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": "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 name", "name": "name", "type": "string" }, + {}, { - "description": "NSX controller port", - "name": "port", - "type": "string" - }, - { - "description": "The name of the edge cluster. An edge cluster is a logical grouping of edge nodes in NSX", - "name": "edgecluster", + "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 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" }, { @@ -34704,9 +34889,14 @@ "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 port", + "name": "port", "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ], "since": "4.19.0" @@ -34717,25 +34907,26 @@ "name": "updateGuiTheme", "params": [ { - "description": "The CSS to be retrieved and imported into the GUI when matching the theme access configurations.", + "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": "css", + "name": "accountids", "required": false, "type": "string" }, { - "description": "A set of domain UUIDs (also known as ID for the end-user) separated by comma that can retrieve the theme.", - "length": 65535, - "name": "domainids", + "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 name to identify the theme.", - "length": 2048, - "name": "name", - "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 set of Common Names (CN) (fixed or wildcard) separated by comma that can retrieve the theme; e.g.: *acme.com,acme2.com", @@ -34745,27 +34936,12 @@ "type": "string" }, { - "description": "Defines whether the subdomains of the informed domains are considered. Default value is false.", - "length": 255, - "name": "recursivedomains", - "required": false, - "type": "boolean" - }, - { - "description": "The JSON with the configurations to be retrieved and imported into the GUI when matching the theme access configurations.", + "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 description for the theme.", "length": 4096, @@ -34781,29 +34957,39 @@ "type": "boolean" }, { - "description": "A set of account UUIDs (also known as ID for the end-user) separated by comma that can retrieve the theme.", + "description": "A name to identify the theme.", + "length": 2048, + "name": "name", + "required": false, + "type": "string" + }, + { + "description": "The JSON with the configurations to be retrieved and imported into the GUI when matching the theme access configurations.", "length": 65535, - "name": "accountids", + "name": "jsonconfiguration", + "required": false, + "type": "string" + }, + { + "description": "A set of domain UUIDs (also known as ID for the end-user) separated by comma that can retrieve the theme.", + "length": 65535, + "name": "domainids", "required": false, "type": "string" } ], "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", + "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "ID of the custom GUI theme.", @@ -34811,56 +34997,60 @@ "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": "Name of the GUI theme.", + "name": "name", "type": "string" }, { - "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": "The CSS to be retrieved and imported into the GUI when matching the theme access configurations.", - "name": "css", + "description": "The JSON with the configurations to be retrieved and imported into the GUI when matching the theme access configurations.", + "name": "jsonconfiguration", "type": "string" }, {}, + { + "description": "When the GUI theme was removed.", + "name": "removed", + "type": "date" + }, { "description": "A set of Common Names (CN) (fixed or wildcard) separated by comma that can retrieve the theme; e.g.: *acme.com,acme2.com", "name": "commonnames", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "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": "When the GUI theme was created.", - "name": "created", - "type": "date" + "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": "Name of the GUI theme.", - "name": "name", + "description": "Description of the GUI theme.", + "name": "description", "type": "string" }, { - "description": "The JSON with the configurations to be retrieved and imported into the GUI when matching the theme access configurations.", - "name": "jsonconfiguration", + "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": "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 created.", + "name": "created", + "type": "date" } ], "since": "4.21.0.0" @@ -34880,15 +35070,12 @@ } ], "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", @@ -34896,12 +35083,15 @@ "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, - {}, - {} + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } ] }, { @@ -34918,19 +35108,19 @@ "type": "uuid" }, { - "description": "the ID of the virtual machine", + "description": "Destination Host ID to migrate VM to.", "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": "hostid", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost", + "required": false, "type": "uuid" }, { - "description": "Destination Host ID to migrate VM to.", + "description": "the ID of the virtual machine", "length": 255, - "name": "hostid", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,addBaremetalHost", - "required": false, + "name": "virtualmachineid", + "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,createVMFromBackup,createVMFromBackup,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", + "required": true, "type": "uuid" }, { @@ -34942,26 +35132,76 @@ "type": "boolean" } ], - "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,createVMFromBackup,createVMFromBackup,assignVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", "response": [ + { + "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": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", + "type": "string" + }, + { + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" + }, + { + "description": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" + }, + { + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, { "description": "NICs of the VNF appliance", "name": "vnfnics", "type": "list" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "the name of the virtual machine", + "name": "name", "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": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "Guest vm Boot Type", + "name": "boottype", + "type": "string" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the type of the template for the virtual machine", + "name": "templatetype", + "type": "string" + }, + { + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { @@ -34970,13 +35210,108 @@ "type": "string" }, { - "description": "the count of GPUs on the virtual machine", - "name": "gpucount", + "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": "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 host for the virtual machine", + "name": "hostname", + "type": "string" + }, + { + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", + "type": "string" + }, + { + "description": "the id of userdata used for the VM", + "name": "userdataid", + "type": "string" + }, + { + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "type": "string" + }, + { + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", + "type": "string" + }, + { + "description": "OS type id of the vm", + "name": "ostypeid", + "type": "string" + }, + { + "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", + "type": "string" + }, + { + "description": "the speed of each vCPU", + "name": "cpuspeed", "type": "integer" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "User VM type", + "name": "vmtype", + "type": "string" + }, + { + "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": "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": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { @@ -34985,213 +35320,397 @@ "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "CPU arch of the VM", + "name": "arch", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the maximum X resolution", + "name": "maxresolutionx", "type": "long" }, + { + "description": "the user's name who deployed the virtual machine", + "name": "username", + "type": "string" + }, + {}, + { + "description": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" + }, + { + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" + }, { "description": "the name of userdata used for the VM", "name": "userdataname", "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "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 virtual network for the service offering", - "name": "forvirtualnetwork", + "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": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the project name of the vm", + "name": "project", + "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": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" + }, + { + "description": "the video RAM size in MB", + "name": "videoram", + "type": "long" + }, + { + "description": "the maximum Y resolution", + "name": "maxresolutiony", + "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 format of the template for the virtual machine", - "name": "templateformat", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "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", + "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 template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", + "type": "string" + }, + { + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + { + "description": "the list of resource tags associated", + "name": "tags", "response": [ { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" - }, - { - "description": "the account owning the affinity group", - "name": "account", + "description": "the project name where tag belongs to", + "name": "project", "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": "the project name of the affinity group", - "name": "project", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the ID of the affinity group", - "name": "id", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" + "description": "id of the resource", + "name": "resourceid", + "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", - "type": "list" + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" } ], "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", - "type": "string" + "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", + "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": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" + "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": "publicip", - "type": "string" + "description": "Instance lease duration in days", + "name": "leaseduration", + "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": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" + "description": "the maximum number of display heads", + "name": "maxheads", + "type": "long" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "ssh key-pairs", + "name": "keypairs", "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": "list of security groups associated with the virtual machine", "name": "securitygroup", "response": [ { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", + "description": "the list of resource tags associated with the rule", + "name": "tags", "response": [ { - "description": "account owning the security group rule", - "name": "account", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "security group name", - "name": "securitygroupname", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the starting IP of the security group rule", - "name": "startport", + "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": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "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 name of the security group", + "name": "name", + "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": "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 virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the description of the security group", + "name": "description", + "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": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", "type": "integer" }, { @@ -35199,28 +35718,28 @@ "name": "tags", "response": [ { - "description": "tag key name", - "name": "key", + "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": "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 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" }, { @@ -35229,33 +35748,43 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "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 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": "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 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", @@ -35266,41 +35795,31 @@ "name": "icmpcode", "type": "integer" }, + { + "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": "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": "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 ingress rules associated with the security group", "name": "ingressrule", "response": [ { - "description": "the type of the ICMP message response", - "name": "icmptype", + "description": "the code for the ICMP message response", + "name": "icmpcode", "type": "integer" }, { @@ -35309,47 +35828,47 @@ "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": "resource type", - "name": "resourcetype", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "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": "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 name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -35363,31 +35882,21 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "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": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, { @@ -35396,110 +35905,23 @@ "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 id of the security group rule", "name": "ruleid", "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 ID of the security group", - "name": "id", - "type": "string" - }, - { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the name of the security group", - "name": "name", - "type": "string" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" - }, - { - "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", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "account owning the security group rule", + "name": "account", "type": "string" } ], @@ -35514,182 +35936,230 @@ "type": "set" }, { - "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": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the state of the virtual machine", + "name": "state", + "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", + "description": "the count of GPUs on the virtual machine", + "name": "gpucount", "type": "integer" }, + { + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", + "type": "string" + }, + { + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "the VM's primary IP address", + "name": "ipaddress", + "type": "string" + }, + {}, { "description": "the user's ID who deployed the virtual machine", "name": "userid", "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" }, { - "description": "Instance lease expiry date", - "name": "leaseexpirydate", - "type": "date" + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "VNF details", + "name": "vnfdetails", + "type": "map" + }, + { + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "the name of the vgpu profile to which service offering is linked", - "name": "vgpuprofilename", + "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": "State of the Service from LB rule", + "name": "servicestate", "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 backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "the format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "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": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the account owning the affinity group", + "name": "account", "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", - "type": "list" + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", + "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" }, { - "description": "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": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "the project name of the affinity group", + "name": "project", "type": "string" - }, + } + ], + "type": "set" + }, + { + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" + }, + { + "description": "the list of nics associated with vm", + "name": "nic", + "response": [ { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the isolation uri of the nic", + "name": "isolationuri", "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": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "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 extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" }, { - "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 IPv6 address of network", - "name": "ip6address", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { @@ -35698,407 +36168,127 @@ "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 Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, { "description": "true if nic is default, false otherwise", "name": "isdefault", "type": "boolean" }, { - "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": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "the type of the nic", + "name": "type", + "type": "string" }, { "description": "IP addresses associated with NIC found for unmanaged VM", "name": "ipaddresses", "type": "list" - } - ], - "type": "set" - }, - { - "description": "Guest vm Boot Type", - "name": "boottype", - "type": "string" - }, - { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "the maximum Y resolution", - "name": "maxresolutiony", - "type": "long" - }, - { - "description": "ssh key-pairs", - "name": "keypairs", - "type": "string" - }, - { - "description": "the id of userdata used for the VM", - "name": "userdataid", - "type": "string" - }, - { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "the maximum X resolution", - "name": "maxresolutionx", - "type": "long" - }, - { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" - }, - { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" - }, - { - "description": "Os type ID of the virtual machine", - "name": "guestosid", - "type": "string" - }, - {}, - { - "description": "the user's name who deployed the virtual machine", - "name": "username", - "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 list of resource tags associated", - "name": "tags", - "response": [ + }, { - "description": "id of the resource", - "name": "resourceid", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", - "type": "string" + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the gateway of the nic", + "name": "gateway", "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": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" } - ], - "type": "set" - }, - {}, - { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" - }, - { - "description": "the pool type of the virtual machine", - "name": "pooltype", - "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": "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 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", - "type": "string" - }, - { - "description": "true if vm has delete protection.", - "name": "deleteprotection", - "type": "boolean" - }, - { - "description": "the VM's primary IP address", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the name of the host for the virtual machine", - "name": "hostname", - "type": "string" - }, - { - "description": "the video RAM size in MB", - "name": "videoram", - "type": "long" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the ID of the virtual machine", - "name": "id", - "type": "string" - }, - { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", - "type": "string" - }, - { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "description": "device type of the root volume", - "name": "rootdevicetype", - "type": "string" - }, - { - "description": "Base64 string containing the user data", - "name": "userdata", - "type": "string" - }, - { - "description": "the state of the virtual machine", - "name": "state", - "type": "string" - }, - { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" - }, - { - "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", - "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 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": "Instance lease duration in days", - "name": "leaseduration", - "type": "integer" - }, - { - "description": "the password (if exists) of the virtual machine", - "name": "password", - "type": "string" - }, - { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", - "type": "string" - }, - { - "description": "User VM type", - "name": "vmtype", - "type": "string" - }, - { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" - }, - { - "description": "Guest vm Boot Mode", - "name": "bootmode", - "type": "string" - }, - { - "description": "OS type id of the vm", - "name": "ostypeid", - "type": "string" - }, - { - "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", - "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": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + ], + "type": "set" }, { - "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": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "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", + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" - }, - { - "description": "Instance lease expiry action", - "name": "leaseexpiryaction", - "type": "string" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" } ] }, @@ -36117,15 +36307,9 @@ } ], "response": [ - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { @@ -36133,12 +36317,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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } ], "since": "4.21.0" }, @@ -36151,33 +36341,33 @@ "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": "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" } ] }, @@ -36194,25 +36384,25 @@ "type": "integer" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" } ], "related": "addBaremetalRct", "response": [ { - "description": "id of rct", - "name": "id", + "description": "url", + "name": "url", "type": "string" }, { @@ -36221,17 +36411,17 @@ "type": "integer" }, { - "description": "url", - "name": "url", + "description": "id of rct", + "name": "id", "type": "string" }, - {}, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - } + }, + {}, + {} ] }, { @@ -36254,23 +36444,23 @@ "name": "jobid", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, {}, { "description": "the CA service provider name", "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 CA service provider", "name": "description", "type": "string" - } + }, + {} ], "since": "4.11.0" }, @@ -36290,16 +36480,6 @@ ], "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", @@ -36310,7 +36490,17 @@ "name": "displaytext", "type": "string" }, - {} + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + } ] }, { @@ -36319,87 +36509,87 @@ "name": "listPortForwardingRules", "params": [ { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "list port forwarding rules for certain network", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "networkid", + "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, + "since": "4.3", "type": "uuid" }, { - "description": "the ID of IP address of the port forwarding services", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "ipaddressid", - "related": "associateIpAddress,reserveIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, "type": "uuid" }, { - "description": "", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "page", + "name": "isrecursive", "required": false, - "type": "integer" + "type": "boolean" }, { - "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": "List resources by tags (key/value pairs)", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "tags", + "name": "account", "required": false, - "type": "map" + "type": "string" }, { - "description": "Lists rule with the specified ID.", + "description": "List by keyword", "length": 255, - "name": "id", - "related": "createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,updateIpv6FirewallRule", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list port forwarding rules for certain network", + "description": "the ID of IP address of the port forwarding services", "length": 255, - "name": "networkid", - "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "ipaddressid", + "related": "associateIpAddress,reserveIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", "required": false, - "since": "4.3", "type": "uuid" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "fordisplay", + "name": "tags", "required": false, - "since": "4.4", - "type": "boolean" + "type": "map" }, { - "description": "list only resources belonging to the domain specified", + "description": "Lists rule with the specified ID.", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "name": "id", + "related": "createRoutingFirewallRule,listRoutingFirewallRules,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule", "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": "", "length": 255, - "name": "listall", + "name": "page", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "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" }, { @@ -36410,76 +36600,75 @@ "type": "integer" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "account", + "name": "listall", "required": false, - "type": "string" + "type": "boolean" } ], - "related": "createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,updateIpv6FirewallRule", + "related": "createRoutingFirewallRule,listRoutingFirewallRules,updateIpv6FirewallRule,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule", "response": [ { - "description": "the VM name for the port forwarding rule", - "name": "virtualmachinename", + "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": "the ID of the port forwarding rule", + "name": "id", "type": "string" }, { - "description": "the ending port of port forwarding rule's private port range", - "name": "privateendport", + "description": "the protocol of the port forwarding rule", + "name": "protocol", "type": "string" }, { - "description": "the VM ID for the port forwarding rule", - "name": "virtualmachineid", + "description": "the VM display name for the port forwarding rule", + "name": "virtualmachinedisplayname", "type": "string" }, { - "description": "the public ip address for the port forwarding rule", - "name": "ipaddress", + "description": "the public ip address id for the port forwarding rule", + "name": "ipaddressid", "type": "string" }, - {}, { - "description": "the VM display name for the port forwarding rule", - "name": "virtualmachinedisplayname", + "description": "the ending port of port forwarding rule's private port range", + "name": "publicendport", "type": "string" }, + {}, { - "description": "the ID of the port forwarding rule", - "name": "id", + "description": "the VM ID for the port forwarding rule", + "name": "virtualmachineid", "type": "string" }, { - "description": "the protocol of the port forwarding rule", - "name": "protocol", + "description": "the ending port of port forwarding rule's private port range", + "name": "privateendport", "type": "string" }, { - "description": "the public ip address id for the port forwarding rule", - "name": "ipaddressid", + "description": "the VM name for the port forwarding rule", + "name": "virtualmachinename", "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", + "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": "publicendport", - "type": "string" + "description": "is firewall for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { "description": "the starting port of port forwarding rule's public port range", @@ -36487,14 +36676,55 @@ "type": "string" }, { - "description": "the state of the rule", - "name": "state", + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, + {}, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, { "description": "the project name where tag belongs to", "name": "project", @@ -36506,393 +36736,1058 @@ "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": "list" + }, + { + "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 UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } + ] + }, + { + "description": "Allocates IP addresses in respective Pod of a Zone", + "isasync": false, + "name": "acquirePodIpAddress", + "params": [ + { + "description": "the ID of the zone", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": true, + "type": "string" + }, + { + "description": "Pod ID", + "length": 255, + "name": "podid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "string" + } + ], + "related": "", + "response": [ + { + "description": "the ID of the pod the IP address belongs to", + "name": "podid", + "type": "long" + }, + { + "description": "Allocated IP address", + "name": "ipaddress", + "type": "string" + }, + { + "description": "Gateway for Pod ", + "name": "gateway", + "type": "string" + }, + { + "description": "MAC address of the pod the IP", + "name": "hostmac", + "type": "long" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the ID of the pod the IP address", + "name": "id", + "type": "long" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the ID of the nic", + "name": "nicid", + "type": "long" + }, + {}, + { + "description": "CIDR of the Pod", + "name": "cidr", + "type": "string" + } + ] + }, + { + "description": "Enables out-of-band management for a cluster", + "isasync": true, + "name": "enableOutOfBandManagementForCluster", + "params": [ + { + "description": "the ID of the cluster", + "length": 255, + "name": "clusterid", + "related": "addCluster,updateCluster", + "required": true, + "type": "uuid" + } + ], + "related": "enableOutOfBandManagementForHost,disableOutOfBandManagementForHost,disableOutOfBandManagementForCluster,configureOutOfBandManagement,changeOutOfBandManagementPassword", + "response": [ + { + "description": "the out-of-band management interface powerState of the host", + "name": "powerstate", + "type": "powerstate" + }, + { + "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 operation result description", + "name": "description", + "type": "string" + }, + {}, + { + "description": "the out-of-band management interface address", + "name": "address", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the ID of the host", + "name": "hostid", + "type": "string" + }, + { + "description": "true if out-of-band management is enabled for the host", + "name": "enabled", + "type": "boolean" + }, + { + "description": "the out-of-band management interface port", + "name": "port", + "type": "string" + }, + { + "description": "the out-of-band management interface username", + "name": "username", + "type": "string" + }, + {}, + { + "description": "the out-of-band management action (if issued)", + "name": "action", + "type": "string" + }, + { + "description": "the operation result", + "name": "status", + "type": "boolean" + } + ], + "since": "4.9.0" + }, + { + "description": "Updates a template visibility permissions. A public template is visible to all accounts within the same domain. A private template is visible only to the owner of the template. A privileged template is a private template with account permissions added. Only accounts specified under the template permissions are visible to them.", + "isasync": false, + "name": "updateTemplatePermissions", + "params": [ + { + "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": "a comma delimited list of projects. 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": "true for featured template/iso, false otherwise", + "length": 255, + "name": "isfeatured", + "required": false, + "type": "boolean" + }, + { + "description": "permission operator (add, remove, reset)", + "length": 255, + "name": "op", + "required": false, + "type": "string" + }, + { + "description": "true if the template/iso is extractable, false other wise. Can be set only by root admin", + "length": 255, + "name": "isextractable", + "required": false, + "type": "boolean" + }, + { + "description": "true for public template/iso, false for private templates/isos", + "length": 255, + "name": "ispublic", + "required": false, + "type": "boolean" + }, + { + "description": "the template ID", + "length": 255, + "name": "id", + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,registerIso,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + } + ] + }, + { + "description": "Resets the password for virtual machine. The virtual machine must be in a \"Stopped\" state and the template must already support this feature for this command to take effect. [async]", + "isasync": true, + "name": "resetPasswordForVirtualMachine", + "params": [ + { + "description": "The new 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", + "type": "string" + }, + { + "description": "The ID of the virtual machine", + "length": 255, + "name": "id", + "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,createVMFromBackup,createVMFromBackup,assignVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", + "required": true, + "type": "uuid" + } + ], + "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,createVMFromBackup,createVMFromBackup,assignVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", + "response": [ + { + "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 read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, + { + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", + "type": "string" + }, + { + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "the state of the virtual machine", + "name": "state", + "type": "string" + }, + { + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", + "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": "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": "the name of the host for the virtual machine", + "name": "hostname", + "type": "string" + }, + { + "description": "the password (if exists) of the virtual machine", + "name": "password", + "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": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" + }, + { + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" + }, + { + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "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 domain name of the security group", + "name": "domain", "type": "string" }, { - "description": "the ID of the domain associated with the tag", + "description": "the domain ID of the security group", "name": "domainid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the name of the security group", + "name": "name", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the description of the security group", + "name": "description", "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 domain associated with the tag", - "name": "domain", + "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": "resource type", - "name": "resourcetype", + "description": "the project name of the group", + "name": "project", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "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 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", + "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": "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": "customer associated with the tag", + "name": "customer", + "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 type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "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 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" + } + ], + "type": "set" + }, + { + "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 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": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "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": "resource type", + "name": "resourcetype", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the list of egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "description": "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": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "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" + }, + { + "description": "tag key name", + "name": "key", + "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 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": "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 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": "path of the Domain the security group belongs to", + "name": "domainpath", "type": "string" } ], - "type": "list" + "type": "set" }, { - "description": "is firewall for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "the id of the guest network the port forwarding rule belongs to", - "name": "networkid", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, + { + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", "type": "string" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - } - ] - }, - { - "description": "Allocates IP addresses in respective Pod of a Zone", - "isasync": false, - "name": "acquirePodIpAddress", - "params": [ + }, { - "description": "Pod ID", - "length": 255, - "name": "podid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "the ID of the zone", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "string" - } - ], - "related": "", - "response": [ + "description": "VNF details", + "name": "vnfdetails", + "type": "map" + }, { - "description": "the ID of the pod the IP address belongs to", - "name": "podid", + "description": "the video RAM size in MB", + "name": "videoram", "type": "long" }, {}, { - "description": "the ID of the pod the IP address", - "name": "id", - "type": "long" + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, { - "description": "CIDR of the Pod", - "name": "cidr", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the ID of the nic", - "name": "nicid", - "type": "long" + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" }, { - "description": "Allocated IP address", - "name": "ipaddress", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, - {}, { - "description": "MAC address of the pod the IP", - "name": "hostmac", - "type": "long" + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "Gateway for Pod ", - "name": "gateway", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" - } - ] - }, - { - "description": "Enables out-of-band management for a cluster", - "isasync": true, - "name": "enableOutOfBandManagementForCluster", - "params": [ - { - "description": "the ID of the cluster", - "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", - "required": true, - "type": "uuid" - } - ], - "related": "enableOutOfBandManagementForHost,disableOutOfBandManagementForHost,disableOutOfBandManagementForCluster,configureOutOfBandManagement,changeOutOfBandManagementPassword", - "response": [ + }, { - "description": "the out-of-band management interface powerState of the host", - "name": "powerstate", - "type": "powerstate" + "description": "the user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" }, - {}, { - "description": "the out-of-band management interface port", - "name": "port", + "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": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "the operation result description", - "name": "description", + "description": "the format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, { - "description": "the out-of-band management driver for the host", - "name": "driver", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "the operation result", - "name": "status", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", "type": "boolean" }, { - "description": "the out-of-band management interface username", - "name": "username", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "the out-of-band management action (if issued)", - "name": "action", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", + "type": "string" }, { - "description": "the out-of-band management interface address", - "name": "address", + "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 host", - "name": "hostid", + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", "type": "string" }, { - "description": "true if out-of-band management is enabled for the host", - "name": "enabled", - "type": "boolean" + "description": "CPU arch of the VM", + "name": "arch", + "type": "string" }, { - "description": "the out-of-band management interface password", - "name": "password", + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" - } - ], - "since": "4.9.0" - }, - { - "description": "Updates a template visibility permissions. A public template is visible to all accounts within the same domain. A private template is visible only to the owner of the template. A privileged template is a private template with account permissions added. Only accounts specified under the template permissions are visible to them.", - "isasync": false, - "name": "updateTemplatePermissions", - "params": [ + }, { - "description": "the template ID", - "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" + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "permission operator (add, remove, reset)", - "length": 255, - "name": "op", - "required": false, + "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": "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": "path of the domain in which the virtual machine exists", + "name": "domainpath", + "type": "string" }, { - "description": "true for public template/iso, false for private templates/isos", - "length": 255, - "name": "ispublic", - "required": false, - "type": "boolean" + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", + "type": "string" }, { - "description": "true for featured template/iso, false otherwise", - "length": 255, - "name": "isfeatured", - "required": false, - "type": "boolean" + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, { - "description": "a comma delimited list of projects. 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 name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" }, { - "description": "true if the template/iso is extractable, false other wise. Can be set only by root admin", - "length": 255, - "name": "isextractable", - "required": false, - "type": "boolean" - } - ], - "response": [ + "description": "Instance lease duration in days", + "name": "leaseduration", + "type": "integer" + }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "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 virtual machine", + "name": "name", + "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ] - }, - { - "description": "Resets the password for virtual machine. The virtual machine must be in a \"Stopped\" state and the template must already support this feature for this command to take effect. [async]", - "isasync": true, - "name": "resetPasswordForVirtualMachine", - "params": [ + "description": "the ID of the host for the virtual machine", + "name": "hostid", + "type": "string" + }, { - "description": "The new 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", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "The ID of the virtual machine", - "length": 255, - "name": "id", - "related": "assignVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", - "required": true, - "type": "uuid" - } - ], - "related": "assignVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", - "response": [ + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "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", "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 write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" + }, { "description": "an alternate display text of the ISO attached to the virtual machine", "name": "isodisplaytext", "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", + "description": "the maximum Y resolution", + "name": "maxresolutiony", + "type": "long" + }, + { + "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", "type": "boolean" }, { - "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 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": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the id of userdata used for the VM", + "name": "userdataid", "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 availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, { @@ -36901,14 +37796,14 @@ "type": "integer" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", - "type": "string" + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { "description": "the VM's disk write in KiB", @@ -36916,144 +37811,122 @@ "type": "long" }, { - "description": "the maximum X resolution", - "name": "maxresolutionx", - "type": "long" - }, - { - "description": "Instance lease expiry action", - "name": "leaseexpiryaction", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "Base64 string containing the user data", - "name": "userdata", - "type": "string" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "User VM type", + "name": "vmtype", "type": "string" }, { - "description": "the maximum number of display heads", - "name": "maxheads", - "type": "long" - }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "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 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 name of the host for the virtual machine", - "name": "hostname", + "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", + "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": "path of the Domain the affinity group belongs to", - "name": "domainpath", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", - "type": "string" + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { - "description": "the description of the affinity group", - "name": "description", - "type": "string" + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "description": "the type of the affinity group", - "name": "type", - "type": "string" + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" }, { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" }, { - "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 name of the affinity group", - "name": "name", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "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": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { @@ -37062,38 +37935,28 @@ "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" }, { - "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", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { @@ -37102,33 +37965,8 @@ "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" - }, - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { @@ -37137,39 +37975,29 @@ "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "the ID of the corresponding network", + "name": "networkid", "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 broadcast uri of the nic", + "name": "broadcasturi", "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": "the ID of the nic", @@ -37177,417 +38005,84 @@ "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "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": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" } ], "type": "set" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "Instance lease expiry date", - "name": "leaseexpirydate", - "type": "date" - }, - { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", - "type": "string" - }, - { - "description": "the 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", - "type": "string" - }, - {}, - { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "true if vm has delete protection.", - "name": "deleteprotection", - "type": "boolean" - }, - { - "description": "the 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", - "type": "string" - }, - { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" - }, - { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" - }, - { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" - }, - { - "description": "Instance lease duration in days", - "name": "leaseduration", - "type": "integer" - }, - { - "description": "the maximum Y resolution", - "name": "maxresolutiony", - "type": "long" - }, - { - "description": "the user's name who deployed the virtual machine", - "name": "username", - "type": "string" - }, - { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" - }, - { - "description": "the list of resource tags associated", - "name": "tags", + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", "response": [ { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" }, { - "description": "the account associated with the tag", + "description": "the account owning the affinity group", "name": "account", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "tag value", - "name": "value", - "type": "string" + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" }, { - "description": "path of the Domain associated with the tag", + "description": "path of the Domain the affinity group belongs to", "name": "domainpath", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" - }, - { - "description": "the type of the template for the virtual machine", - "name": "templatetype", - "type": "string" - }, - {}, - { - "description": "State of the Service from LB rule", - "name": "servicestate", - "type": "string" - }, - { - "description": "the count of GPUs on the virtual machine", - "name": "gpucount", - "type": "integer" - }, - { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "type": "string" + "description": "the domain name of the affinity group", + "name": "domain", + "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 description of the affinity group", + "name": "description", + "type": "string" + } + ], + "type": "set" }, { "description": "the name of the template for the virtual machine", @@ -37595,406 +38090,101 @@ "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "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", + "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 maximum number of display heads", + "name": "maxheads", + "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": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "description": "User VM type", - "name": "vmtype", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", + "description": "the list of resource tags associated", + "name": "tags", "response": [ { - "description": "the ID of the security group", - "name": "id", + "description": "the project id the tag belongs to", + "name": "projectid", "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 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" - }, - { - "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 project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "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", - "type": "string" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - } - ], - "type": "set" - }, - { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "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": "the domain name of the security group", - "name": "domain", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "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": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the 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", + "description": "the project name where tag belongs to", "name": "project", "type": "string" }, { - "description": "the domain ID of the security group", - "name": "domainid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the project id of the group", - "name": "projectid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the name of the security group", - "name": "name", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" + "description": "resource type", + "name": "resourcetype", + "type": "string" }, { - "description": "the description of the security group", - "name": "description", + "description": "tag key name", + "name": "key", "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 list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "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 ID of the domain associated with the tag", - "name": "domainid", - "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 starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - } - ], - "type": "set" + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" } ], "type": "set" - }, - { - "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", - "type": "string" } ] }, @@ -38018,23 +38208,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": "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" }, @@ -38043,6 +38233,13 @@ "isasync": false, "name": "listBrocadeVcsDevices", "params": [ + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, { "description": "Brocade VCS switch ID", "length": 255, @@ -38052,11 +38249,12 @@ "type": "uuid" }, { - "description": "", + "description": "the Physical Network ID", "length": 255, - "name": "pagesize", + "name": "physicalnetworkid", + "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", "required": false, - "type": "integer" + "type": "uuid" }, { "description": "List by keyword", @@ -38071,55 +38269,47 @@ "name": "page", "required": false, "type": "integer" - }, - { - "description": "the Physical Network ID", - "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", - "required": false, - "type": "uuid" } ], "related": "", "response": [ + {}, { - "description": "the principal switch Ip address", - "name": "hostname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "device name", + "name": "brocadedevicename", "type": "string" }, - {}, { "description": "device id of the Brocade Vcs", "name": "vcsdeviceid", "type": "string" }, - {}, + { + "description": "the principal switch Ip address", + "name": "hostname", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - { - "description": "the physical Network to which this Brocade VCS belongs to", - "name": "physicalnetworkid", - "type": "string" - }, { "description": "name of the provider", "name": "provider", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the physical Network to which this Brocade VCS belongs to", + "name": "physicalnetworkid", "type": "string" }, - { - "description": "device name", - "name": "brocadedevicename", - "type": "string" - } + {} ] }, { @@ -38127,6 +38317,13 @@ "isasync": false, "name": "linkDomainToLdap", "params": [ + { + "description": "domain admin username in LDAP ", + "length": 255, + "name": "admin", + "required": false, + "type": "string" + }, { "description": "type of the ldap name. GROUP or OU", "length": 255, @@ -38142,13 +38339,6 @@ "required": true, "type": "uuid" }, - { - "description": "domain admin username in LDAP ", - "length": 255, - "name": "admin", - "required": false, - "type": "string" - }, { "description": "Type of the account to auto import. Specify 0 for user and 2 for domain admin", "length": 255, @@ -38159,60 +38349,60 @@ { "description": "name of the group or OU in LDAP", "length": 255, - "name": "ldapdomain", + "name": "name", "required": false, "type": "string" }, { "description": "name of the group or OU in LDAP", "length": 255, - "name": "name", + "name": "ldapdomain", "required": false, "type": "string" } ], "related": "linkAccountToLdap", "response": [ - {}, { - "description": "type of the name in LDAP which is linked to the domain", - "name": "type", + "description": "Domain Admin accountId that is created", + "name": "accountid", "type": "string" }, - {}, { - "description": "the current status of the latest 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": "Type of the account to auto import", "name": "accounttype", "type": "int" }, { - "description": "Domain Admin accountId that is created", - "name": "accountid", + "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": "name", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "name of the group or OU in LDAP which is linked to the domain", - "name": "ldapdomain", + "name": "name", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "type of the name in LDAP which is linked to the domain", + "name": "type", "type": "string" }, { - "description": "id of the Domain which is linked to LDAP", - "name": "domainid", + "description": "name of the group or OU in LDAP which is linked to the domain", + "name": "ldapdomain", "type": "string" } ], @@ -38223,6 +38413,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,41 +38427,24 @@ "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", + "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 state of the management server", + "name": "state", + "type": "state" }, {}, { @@ -38272,27 +38452,37 @@ "name": "shutdowntriggered", "type": "boolean" }, + {}, { - "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 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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The id of the management server", + "name": "managementserverid", "type": "string" }, { - "description": "Indicates whether CloudStack is ready to shutdown", - "name": "readyforshutdown", + "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" + } ], "since": "4.21.0" }, @@ -38308,13 +38498,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 +38505,17 @@ "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", - "type": "string" - }, - {}, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -38349,15 +38532,22 @@ "type": "string" }, { - "description": "the user ID", - "name": "id", + "description": "the user name", + "name": "username", "type": "string" }, + {}, { - "description": "the user name", - "name": "username", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - } + }, + { + "description": "the user ID", + "name": "id", + "type": "string" + }, + {} ], "since": "4.18.0" }, @@ -38367,16 +38557,16 @@ "name": "listVpnCustomerGateways", "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": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, @@ -38388,47 +38578,47 @@ "type": "boolean" }, { - "description": "", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "pagesize", + "name": "listall", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "list only resources belonging to the domain specified", + "description": "id of the customer gateway", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "name": "id", + "related": "createVpnCustomerGateway,listVpnCustomerGateways,updateVpnCustomerGateway", "required": false, "type": "uuid" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "account", "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 only resources belonging to the domain specified", "length": 255, - "name": "listall", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "id of the customer gateway", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "id", - "related": "createVpnCustomerGateway,listVpnCustomerGateways,updateVpnCustomerGateway", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, "type": "uuid" } @@ -38436,29 +38626,34 @@ "related": "createVpnCustomerGateway,updateVpnCustomerGateway", "response": [ { - "description": "the domain name of the owner", - "name": "domain", + "description": "IPsec policy of customer gateway", + "name": "esppolicy", "type": "string" }, { - "description": "the vpn gateway ID", - "name": "id", + "description": "Lifetime of ESP SA of customer gateway", + "name": "esplifetime", + "type": "long" + }, + { + "description": "the project id", + "name": "projectid", "type": "string" }, { - "description": "IKE policy of customer gateway", - "name": "ikepolicy", + "description": "the domain name of the owner", + "name": "domain", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "IPsec preshared-key of customer gateway", + "name": "ipsecpsk", + "type": "string" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", @@ -38466,29 +38661,25 @@ "type": "integer" }, { - "description": "For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.", - "name": "splitconnections", - "type": "boolean" - }, - { - "description": "if Force NAT Encapsulation is enabled for customer gateway", - "name": "forceencap", - "type": "boolean" + "description": "the vpn gateway ID", + "name": "id", + "type": "string" }, + {}, { "description": "public ip address id of the customer gateway", "name": "gateway", "type": "string" }, { - "description": "the owner", - "name": "account", + "description": "the project name", + "name": "project", "type": "string" }, { - "description": "IPsec policy of customer gateway", - "name": "esppolicy", - "type": "string" + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" }, { "description": "if DPD is enabled for customer gateway", @@ -38496,28 +38687,23 @@ "type": "boolean" }, { - "description": "the project name", - "name": "project", - "type": "string" - }, - { - "description": "name of the customer gateway", - "name": "name", + "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { - "description": "the domain path of the owner", - "name": "domainpath", + "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", + "name": "ikeversion", "type": "string" }, { - "description": "the project id", - "name": "projectid", + "description": "the domain id of the owner", + "name": "domainid", "type": "string" }, { - "description": "Lifetime of ESP SA of customer gateway", - "name": "esplifetime", + "description": "Lifetime of IKE SA of customer gateway", + "name": "ikelifetime", "type": "long" }, { @@ -38527,34 +38713,38 @@ }, {}, { - "description": "the domain id of the owner", - "name": "domainid", + "description": "the owner", + "name": "account", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "if Force NAT Encapsulation is enabled for customer gateway", + "name": "forceencap", + "type": "boolean" }, { - "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", - "name": "ikeversion", + "description": "name of the customer gateway", + "name": "name", "type": "string" }, - {}, { - "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "IKE policy of customer gateway", + "name": "ikepolicy", "type": "string" }, { - "description": "Lifetime of IKE SA of customer gateway", - "name": "ikelifetime", - "type": "long" + "description": "For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.", + "name": "splitconnections", + "type": "boolean" }, { - "description": "IPsec preshared-key of customer gateway", - "name": "ipsecpsk", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the domain path of the owner", + "name": "domainpath", "type": "string" } ] @@ -38565,17 +38755,17 @@ "name": "deleteKubernetesCluster", "params": [ { - "description": "Destroy attached instances of the ExternalManaged Cluster. Default: false", + "description": "Expunge attached instances of the ExternalManaged Cluster. If true, value of cleanup is ignored. Default: false", "length": 255, - "name": "cleanup", + "name": "expunge", "required": false, "since": "4.19.0", "type": "boolean" }, { - "description": "Expunge attached instances of the ExternalManaged Cluster. If true, value of cleanup is ignored. Default: false", + "description": "Destroy attached instances of the ExternalManaged Cluster. Default: false", "length": 255, - "name": "expunge", + "name": "cleanup", "required": false, "since": "4.19.0", "type": "boolean" @@ -38601,17 +38791,17 @@ "name": "jobid", "type": "string" }, - {}, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - } + {} ] }, { @@ -38619,14 +38809,6 @@ "isasync": false, "name": "listWebhooks", "params": [ - { - "description": "The ID of the Webhook", - "length": 255, - "name": "id", - "related": "createWebhook,listWebhooks,listWebhookDeliveries", - "required": false, - "type": "uuid" - }, { "description": "The state of the Webhook", "length": 255, @@ -38634,14 +38816,6 @@ "required": false, "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 name of the Webhook", "length": 255, @@ -38650,46 +38824,56 @@ "type": "string" }, { - "description": "List by keyword", + "description": "The ID of the Webhook", "length": 255, - "name": "keyword", + "name": "id", + "related": "createWebhook,listWebhooks,listWebhookDeliveries", "required": false, - "type": "string" + "type": "uuid" }, { - "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": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, - "type": "string" + "type": "uuid" }, { - "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": "", "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": "list only resources belonging to the domain specified", "length": 255, - "name": "listall", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" + }, + { + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, + "type": "string" }, { "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", @@ -38699,56 +38883,52 @@ "type": "boolean" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "The scope of the Webhook", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "scope", "required": false, - "type": "uuid" + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" } ], "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", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The secret key for the Webhook", + "name": "secretkey", + "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 project name of the Kubernetes cluster", - "name": "project", + "description": "the project id of the Kubernetes cluster", + "name": "projectid", "type": "string" }, {}, { - "description": "The scope of the Webhook", - "name": "scope", + "description": "The payload URL end point for the Webhook", + "name": "payloadurl", "type": "string" }, { - "description": "The date when this Webhook was created", - "name": "created", - "type": "date" - }, - { - "description": "Whether SSL verification is enabled for the Webhook", - "name": "sslverification", - "type": "boolean" + "description": "path of the domain to which the Webhook belongs", + "name": "domainpath", + "type": "string" }, { "description": "The ID of the Webhook", @@ -38760,10 +38940,11 @@ "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", @@ -38776,21 +38957,30 @@ "type": "string" }, { - "description": "The secret key for the Webhook", - "name": "secretkey", + "description": "The ID of the domain in which the Webhook exists", + "name": "domainid", "type": "string" }, - {}, { - "description": "the project id of the Kubernetes cluster", - "name": "projectid", + "description": "The scope of the Webhook", + "name": "scope", "type": "string" }, { - "description": "The payload URL end point for the Webhook", - "name": "payloadurl", + "description": "the project name of the Kubernetes cluster", + "name": "project", "type": "string" }, + { + "description": "The date when this Webhook 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 Webhook", "name": "name", @@ -38804,13 +38994,6 @@ "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", - "required": false, - "type": "string" - }, { "description": "GSLB service type (tcp, udp, http)", "length": 255, @@ -38819,17 +39002,17 @@ "type": "string" }, { - "description": "session sticky method (sourceip) if not specified defaults to sourceip", + "description": "load balancer algorithm (roundrobin, leastconn, proximity) that method is used to distribute traffic across the zones participating in global server load balancing, if not specified defaults to 'round robin'", "length": 255, - "name": "gslbstickysessionmethodname", + "name": "gslblbmethod", "required": false, "type": "string" }, { - "description": "load balancer algorithm (roundrobin, leastconn, proximity) that method is used to distribute traffic across the zones participating in global server load balancing, if not specified defaults to 'round robin'", + "description": "domain name for the GSLB service.", "length": 255, - "name": "gslblbmethod", - "required": false, + "name": "gslbdomainname", + "required": true, "type": "string" }, { @@ -38841,12 +39024,18 @@ "type": "uuid" }, { - "description": "region where the global load balancer is going to be created.", + "description": "name of the load balancer rule", "length": 255, - "name": "regionid", - "related": "addRegion,updateRegion,listRegions", + "name": "name", "required": true, - "type": "integer" + "type": "string" + }, + { + "description": "session sticky method (sourceip) if not specified defaults to sourceip", + "length": 255, + "name": "gslbstickysessionmethodname", + "required": false, + "type": "string" }, { "description": "the description of the load balancer rule", @@ -38856,54 +39045,91 @@ "type": "string" }, { - "description": "domain name for the GSLB service.", + "description": "region where the global load balancer is going to be created.", "length": 255, - "name": "gslbdomainname", + "name": "regionid", + "related": "addRegion,updateRegion,listRegions", "required": true, - "type": "string" + "type": "integer" }, { - "description": "name of the load balancer rule", + "description": "the account associated with the global load balancer. Must be used with the domainId parameter.", "length": 255, - "name": "name", - "required": true, + "name": "account", + "required": false, "type": "string" } ], "related": "listGlobalLoadBalancerRules,updateGlobalLoadBalancerRule", "response": [ + {}, { - "description": "the domain of the load balancer rule", - "name": "domain", - "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 load balancer", "name": "projectid", "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": "session persistence method used for the global load balancer", "name": "gslbstickysessionmethodname", "type": "string" }, { - "description": "the description of the global load balancer rule", - "name": "description", + "description": "the domain of the load balancer rule", + "name": "domain", + "type": "string" + }, + { + "description": "GSLB service type", + "name": "gslbservicetype", "type": "string" }, { "description": "List of load balancer rules that are part of GSLB rule", "name": "loadbalancerrule", "response": [ + { + "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", + "type": "string" + }, + { + "description": "the name of the zone the load balancer rule belongs to", + "name": "zonename", + "type": "string" + }, { "description": "the account of the load balancer rule", "name": "account", "type": "string" }, { - "description": "the name of the load balancer", - "name": "name", + "description": "the project name of the load balancer", + "name": "project", + "type": "string" + }, + { + "description": "the protocol of the loadbalanacer rule", + "name": "protocol", "type": "string" }, { @@ -38911,6 +39137,16 @@ "name": "algorithm", "type": "string" }, + { + "description": "the public ip address", + "name": "publicip", + "type": "string" + }, + { + "description": "the public port", + "name": "publicport", + "type": "string" + }, { "description": "the list of resource tags associated with load balancer", "name": "tags", @@ -38921,33 +39157,28 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", - "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": "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": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -38956,8 +39187,8 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -38966,31 +39197,36 @@ "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" } ], "type": "list" }, { - "description": "the public ip address", - "name": "publicip", + "description": "the domain of the load balancer rule", + "name": "domain", "type": "string" }, { - "description": "path of the domain to which the load balancer rule belongs", - "name": "domainpath", - "type": "string" + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the protocol of the loadbalanacer rule", - "name": "protocol", + "description": "the name of the load balancer", + "name": "name", "type": "string" }, { - "description": "the public ip address id", - "name": "publicipid", + "description": "path of the domain to which the load balancer rule belongs", + "name": "domainpath", "type": "string" }, { @@ -39004,18 +39240,8 @@ "type": "string" }, { - "description": "the CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,).", - "name": "cidrlist", - "type": "string" - }, - { - "description": "the name of the zone the load balancer rule belongs to", - "name": "zonename", - "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" }, { @@ -39024,18 +39250,8 @@ "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": "the load balancer rule ID", + "name": "id", "type": "string" }, { @@ -39043,47 +39259,23 @@ "name": "description", "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" + "description": "the state of the rule", + "name": "state", + "type": "string" } ], "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", - "type": "string" - }, - { - "description": "name of the global load balancer rule", - "name": "name", + "description": "the description of the global load balancer rule", + "name": "description", "type": "string" }, { @@ -39092,8 +39284,8 @@ "type": "string" }, { - "description": "the domain ID of the load balancer rule", - "name": "domainid", + "description": "the project name of the load balancer", + "name": "project", "type": "string" }, { @@ -39102,32 +39294,30 @@ "type": "string" }, { - "description": "GSLB service type", - "name": "gslbservicetype", + "description": "global load balancer rule ID", + "name": "id", "type": "string" }, { - "description": "Load balancing method used for the global load balancer", - "name": "gslblbmethod", + "description": "name of the global load balancer rule", + "name": "name", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "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": "Load balancing method used for the global load balancer", + "name": "gslblbmethod", "type": "string" }, { - "description": "path of the domain to which the load balancer rule belongs", - "name": "domainpath", + "description": "the domain ID of the load balancer rule", + "name": "domainid", "type": "string" - }, - {} + } ] }, { @@ -39146,6 +39336,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", @@ -39156,17 +39351,12 @@ "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" - } + }, + {} ] }, { @@ -39175,18 +39365,18 @@ "name": "listTags", "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 resource id", "length": 255, - "name": "listall", + "name": "resourceid", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { "description": "list by customer name", @@ -39195,13 +39385,6 @@ "required": false, "type": "string" }, - { - "description": "list by resource type", - "length": 255, - "name": "resourcetype", - "required": false, - "type": "string" - }, { "description": "list by key", "length": 255, @@ -39209,13 +39392,6 @@ "required": false, "type": "string" }, - { - "description": "list by value", - "length": 255, - "name": "value", - "required": false, - "type": "string" - }, { "description": "list only resources belonging to the domain specified", "length": 255, @@ -39225,16 +39401,9 @@ "type": "uuid" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "list by resource id", + "description": "list by resource type", "length": 255, - "name": "resourceid", + "name": "resourcetype", "required": false, "type": "string" }, @@ -39254,50 +39423,73 @@ "type": "boolean" }, { - "description": "List by keyword", + "description": "list by value", "length": 255, - "name": "keyword", + "name": "value", "required": false, "type": "string" }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "length": 255, + "name": "listall", + "required": false, + "type": "boolean" + }, { "description": "list resources by 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" } ], "related": "listResourceDetails", "response": [ { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "id of the resource", - "name": "resourceid", + "description": "the ID of the domain associated with the tag", + "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 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": "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": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -39306,35 +39498,33 @@ "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": "resource type", + "name": "resourcetype", "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 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 account associated with the tag", + "name": "account", "type": "string" }, - {}, { - "description": "tag key name", - "name": "key", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ], @@ -39346,20 +39536,13 @@ "name": "listAffectedVmsForStorageScopeChange", "params": [ { - "description": "the Id of the storage pool on which change scope operation is being done", + "description": "the Id of the cluster the scope of the storage pool is being changed to", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "name": "clusterid", + "related": "addCluster,updateCluster", "required": true, "type": "uuid" }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, { "description": "", "length": 255, @@ -39375,46 +39558,59 @@ "type": "string" }, { - "description": "the Id of the cluster the scope of the storage pool is being changed to", + "description": "", "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "the Id of the storage pool on which change scope operation is being done", + "length": 255, + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", "required": true, "type": "uuid" } ], "related": "", "response": [ + {}, { - "description": "the cluster name for the VM", - "name": "clustername", + "description": "the UUID of the latest async 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 VM", "name": "name", "type": "string" }, { - "description": "the type of VM", - "name": "type", + "description": "the cluster ID for the VM", + "name": "clusterid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the hostname for the VM", + "name": "hostname", "type": "string" }, { - "description": "the hostname for the VM", - "name": "hostname", + "description": "the type of VM", + "name": "type", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the cluster name for the VM", + "name": "clustername", + "type": "string" }, { "description": "the ID of the VM", @@ -39425,13 +39621,7 @@ "description": "the host ID for the VM", "name": "hostid", "type": "string" - }, - { - "description": "the cluster ID for the VM", - "name": "clusterid", - "type": "string" - }, - {} + } ], "since": "4.19.1" }, @@ -39441,56 +39631,50 @@ "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", - "related": "addNetworkServiceProvider,listNetworkServiceProviders,listTrafficTypes", - "required": false, + "name": "nspid", + "related": "addNetworkServiceProvider,listNetworkServiceProviders", + "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", - "related": "addNetworkServiceProvider,listNetworkServiceProviders,listTrafficTypes", - "required": true, + "name": "providertype", + "related": "addNetworkServiceProvider,listNetworkServiceProviders", + "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 project name of the address", + "name": "project", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "the physical network service provider id of the provider", "name": "nspid", "type": "string" }, - {}, { "description": "the account associated with the provider", "name": "account", "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the domain associated with the provider", + "name": "domain", "type": "string" }, + {}, { "description": "the id of the router", "name": "id", @@ -39512,9 +39696,15 @@ "type": "string" }, { - "description": "the domain associated with the provider", - "name": "domain", + "description": "path of the domain to which the provider belongs", + "name": "domainpath", "type": "string" + }, + {}, + { + "description": "Enabled/Disabled the service provider", + "name": "enabled", + "type": "boolean" } ] }, @@ -39524,66 +39714,58 @@ "name": "createVPC", "params": [ { - "description": "the ID of the availability zone", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "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 networks in ths VPC. \nIf an address is given and it cannot be acquired, an error will be returned and the network won´t be implemented,", + "description": "the first IPv6 DNS for the VPC", "length": 255, - "name": "sourcenatipaddress", + "name": "ip6dns1", "required": false, - "since": "4.19", + "since": "4.18.0", "type": "string" }, { - "description": "the CIDR size of VPC. For regular users, this is required for VPC with ROUTED mode.", + "description": "MTU to be configured on the network VR's public facing interfaces", "length": 255, - "name": "cidrsize", + "name": "publicmtu", "required": false, - "since": "4.20.0", + "since": "4.18.0", "type": "integer" }, { - "description": "the first IPv6 DNS for the VPC", + "description": "an optional field, whether to the display the vpc to the end user or not", "length": 255, - "name": "ip6dns1", + "name": "fordisplay", "required": false, - "since": "4.18.0", - "type": "string" + "since": "4.4", + "type": "boolean" }, { - "description": "the second IPv4 DNS for the VPC", + "description": "The display text of the VPC, defaults to its 'name'.", "length": 255, - "name": "dns2", + "name": "displaytext", "required": false, - "since": "4.18.0", "type": "string" }, { - "description": "the cidr of the VPC. All VPC guest networks' cidrs should be within this CIDR", + "description": "the ID of the availability zone", "length": 255, - "name": "cidr", - "required": false, - "type": "string" + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": true, + "type": "uuid" }, { - "description": "the AS Number of the VPC tiers", + "description": "the account associated with the VPC. Must be used with the domainId parameter.", "length": 255, - "name": "asnumber", + "name": "account", "required": false, - "since": "4.20.0", - "type": "long" + "type": "string" }, { - "description": "The display text of the VPC, defaults to its 'name'.", + "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": "displaytext", + "name": "start", "required": false, - "type": "string" + "since": "4.3", + "type": "boolean" }, { "description": "create VPC for the project", @@ -39601,12 +39783,27 @@ "type": "boolean" }, { - "description": "the ID of the VPC offering", + "description": "the second IPv6 DNS for the VPC", "length": 255, - "name": "vpcofferingid", - "related": "updateVPCOffering,listVPCOfferings", - "required": true, - "type": "uuid" + "name": "ip6dns2", + "required": false, + "since": "4.18.0", + "type": "string" + }, + { + "description": "the cidr of the VPC. All VPC guest networks' cidrs should be within this CIDR", + "length": 255, + "name": "cidr", + "required": false, + "type": "string" + }, + { + "description": "the first IPv4 DNS for the VPC", + "length": 255, + "name": "dns1", + "required": false, + "since": "4.18.0", + "type": "string" }, { "description": "the name of the VPC", @@ -39616,43 +39813,52 @@ "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": "the CIDR size of VPC. For regular users, this is required for VPC with ROUTED mode.", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "name": "cidrsize", "required": false, - "type": "uuid" + "since": "4.20.0", + "type": "integer" }, { - "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", + "name": "vpcofferingid", + "related": "updateVPCOffering,listVPCOfferings", + "required": true, + "type": "uuid" + }, + { + "description": "the AS Number of the VPC tiers", + "length": 255, + "name": "asnumber", "required": false, - "type": "string" + "since": "4.20.0", + "type": "long" }, { - "description": "the second IPv6 DNS for the VPC", + "description": "the second IPv4 DNS for the VPC", "length": 255, - "name": "ip6dns2", + "name": "dns2", "required": false, "since": "4.18.0", "type": "string" }, { - "description": "MTU to be configured on the network VR's public facing interfaces", + "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": "publicmtu", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, - "since": "4.18.0", - "type": "integer" + "type": "uuid" }, { "description": "Ids of the Bgp Peer for the VPC", @@ -39664,25 +39870,9 @@ "type": "list" }, { - "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": "start", - "required": false, - "since": "4.3", - "type": "boolean" - }, - { - "description": "an optional field, whether to the display the vpc to the end user or not", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" - }, - { - "description": "the account associated with the VPC. Must be used with the domainId parameter.", + "description": "VPC network domain. All networks inside the VPC will belong to this domain", "length": 255, - "name": "account", + "name": "networkdomain", "required": false, "type": "string" } @@ -39690,59 +39880,18 @@ "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", + "description": "is VPC uses distributed router for one hop forwarding and host based network ACL's", + "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", - "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": "true if VPC is region level", + "name": "regionlevelvpc", + "type": "boolean" }, { - "description": "the second IPv4 DNS for the VPC", - "name": "dns2", + "description": "the network domain of the VPC", + "name": "networkdomain", "type": "string" }, { @@ -39750,13 +39899,13 @@ "name": "tags", "response": [ { - "description": "id of the resource", - "name": "resourceid", + "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" }, { @@ -39770,23 +39919,23 @@ "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": "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": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -39795,87 +39944,47 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "id of the resource", + "name": "resourceid", "type": "string" } ], "type": "list" }, { - "description": "is VPC uses distributed router for one hop forwarding and host based network ACL's", - "name": "distributedvpcrouter", - "type": "boolean" - }, - { - "description": "zone id of the vpc", - "name": "zoneid", - "type": "string" - }, - { - "description": "the domain name of the owner", - "name": "domain", - "type": "string" - }, - { - "description": "the owner of the VPC", - "name": "account", - "type": "string" - }, - { - "description": "UUID of AS NUMBER", - "name": "asnumberid", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "true if VPC is region level", - "name": "regionlevelvpc", - "type": "boolean" + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" }, { "description": "the second IPv6 DNS for the VPC", "name": "ip6dns2", "type": "string" }, - { - "description": "if this VPC has redundant router", - "name": "redundantvpcrouter", - "type": "boolean" - }, - { - "description": "The BGP peers for the VPC", - "name": "bgppeers", - "type": "set" - }, { "description": "the project name of the VPC", "name": "project", "type": "string" }, { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip6routes", - "type": "set" + "description": "the list of networks belongign to the VPC", + "name": "network", + "type": "list" }, { - "description": "the cidr the VPC", - "name": "cidr", - "type": "string" + "description": "AS NUMBER", + "name": "asnumber", + "type": "long" }, { - "description": "the network domain of the VPC", - "name": "networkdomain", - "type": "string" + "description": "the date this VPC was created", + "name": "created", + "type": "date" }, { "description": "Base64 string representation of the resource icon", @@ -39888,35 +39997,46 @@ "type": "string" }, { - "description": "The routes for the VPC to ease adding route in upstream router", - "name": "ip4routes", - "type": "set" + "description": "the domain name of the owner", + "name": "domain", + "type": "string" + }, + { + "description": "MTU configured on the public interfaces of the VPC VR", + "name": "publicmtu", + "type": "integer" }, {}, { - "description": "the name of the zone the VPC belongs to", - "name": "zonename", - "type": "string" + "description": "is vpc for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the date this VPC was created", - "name": "created", - "type": "date" + "description": "the first IPv4 DNS for the VPC", + "name": "dns1", + "type": "string" }, { - "description": "AS NUMBER", - "name": "asnumber", - "type": "long" + "description": "the domain path of the owner", + "name": "domainpath", + "type": "string" }, + {}, { - "description": "state of the VPC. Can be Inactive/Enabled", - "name": "state", + "description": "the name of the VPC", + "name": "name", "type": "string" }, { "description": "the list of supported services", "name": "service", "response": [ + { + "description": "the service name", + "name": "name", + "type": "string" + }, { "description": "the list of capabilities", "name": "capability", @@ -39939,18 +40059,18 @@ ], "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": "services for this provider", + "name": "servicelist", + "type": "list" + }, + { + "description": "state of the network provider", + "name": "state", "type": "string" }, { @@ -39958,11 +40078,6 @@ "name": "canenableindividualservice", "type": "boolean" }, - { - "description": "services for this provider", - "name": "servicelist", - "type": "list" - }, { "description": "the provider name", "name": "name", @@ -39974,13 +40089,13 @@ "type": "string" }, { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", + "description": "uuid of the network provider", + "name": "id", "type": "string" }, { - "description": "state of the network provider", - "name": "state", + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", "type": "string" } ], @@ -39990,9 +40105,29 @@ "type": "list" }, { - "description": "true VPC requires restart", - "name": "restartrequired", - "type": "boolean" + "description": "an alternate display text of the VPC.", + "name": "displaytext", + "type": "string" + }, + { + "description": "vpc offering name the VPC is created from", + "name": "vpcofferingname", + "type": "string" + }, + { + "description": "vpc offering id the VPC is created from", + "name": "vpcofferingid", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the second IPv4 DNS for the VPC", + "name": "dns2", + "type": "string" }, { "description": "the first IPv6 DNS for the VPC", @@ -40000,24 +40135,79 @@ "type": "string" }, { - "description": "the domain path of the owner", - "name": "domainpath", + "description": "the cidr the VPC", + "name": "cidr", "type": "string" }, { - "description": "is vpc for display to the regular user", - "name": "fordisplay", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the first IPv4 DNS for the VPC", - "name": "dns1", + "description": "the name of the zone the VPC belongs to", + "name": "zonename", + "type": "string" + }, + { + "description": "the owner of the VPC", + "name": "account", + "type": "string" + }, + { + "description": "The BGP peers for the VPC", + "name": "bgppeers", + "type": "set" + }, + { + "description": "the id of the VPC", + "name": "id", + "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": "true VPC requires restart", + "name": "restartrequired", + "type": "boolean" + }, + { + "description": "UUID of AS NUMBER", + "name": "asnumberid", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the project id of the VPC", "name": "projectid", "type": "string" + }, + { + "description": "zone id of the vpc", + "name": "zoneid", + "type": "string" + }, + { + "description": "if this VPC has redundant router", + "name": "redundantvpcrouter", + "type": "boolean" + }, + { + "description": "The routes for the VPC to ease adding route in upstream router", + "name": "ip4routes", + "type": "set" } ] }, @@ -40026,6 +40216,13 @@ "isasync": true, "name": "removeResourceDetail", "params": [ + { + "description": "Delete details for resource id", + "length": 255, + "name": "resourceid", + "required": true, + "type": "string" + }, { "description": "Delete detail by resource type", "length": 255, @@ -40039,37 +40236,30 @@ "name": "key", "required": false, "type": "string" - }, - { - "description": "Delete details for resource id", - "length": 255, - "name": "resourceid", - "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" }, - {}, { - "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" } ] }, @@ -40079,27 +40269,28 @@ "name": "listOsTypes", "params": [ { - "description": "", + "description": "list os by description", "length": 255, - "name": "pagesize", + "name": "description", "required": false, - "type": "integer" + "since": "3.0.1", + "type": "string" }, { - "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 Os Category id", "length": 255, - "name": "description", + "name": "oscategoryid", + "related": "listOsCategories,addOsCategory", "required": false, - "since": "3.0.1", - "type": "string" + "type": "uuid" }, { "description": "List by keyword", @@ -40109,27 +40300,26 @@ "type": "string" }, { - "description": "", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "page", + "name": "fordisplay", "required": false, - "type": "integer" + "since": "4.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": "", "length": 255, - "name": "id", - "related": "listOsTypes,addGuestOs", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" } ], "related": "addGuestOs", @@ -40140,46 +40330,46 @@ "type": "string" }, { - "description": "is the guest OS user defined", - "name": "isuserdefined", - "type": "boolean" - }, - {}, - { - "description": "the name of the OS category", - "name": "oscategoryname", + "description": "the name of the OS type", + "name": "name", "type": "string" }, - {}, { "description": "the name/description of the OS type", "name": "description", "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 ID of the OS category", "name": "oscategoryid", "type": "string" }, + {}, { "description": "the ID of the OS type", "name": "id", "type": "string" }, - { - "description": "the name of the OS type", - "name": "name", - "type": "string" - }, - { - "description": "is the guest OS visible for the users", - "name": "fordisplay", - "type": "boolean" - }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" + }, + { + "description": "the name of the OS category", + "name": "oscategoryname", + "type": "string" } ] }, @@ -40189,20 +40379,12 @@ "name": "updateGpuCard", "params": [ { - "description": "the vendor name of the GPU card", + "description": "the device name of the GPU card", "length": 255, - "name": "vendorname", + "name": "devicename", "required": false, "type": "string" }, - { - "description": "the ID of the GPU card", - "length": 255, - "name": "id", - "related": "updateGpuCard,listGpuCards", - "required": true, - "type": "uuid" - }, { "description": "the display name of the GPU card", "length": 255, @@ -40211,57 +40393,65 @@ "type": "string" }, { - "description": "the device name of the GPU card", + "description": "the vendor name of the GPU card", "length": 255, - "name": "devicename", + "name": "vendorname", "required": false, "type": "string" + }, + { + "description": "the ID of the GPU card", + "length": 255, + "name": "id", + "related": "updateGpuCard,listGpuCards", + "required": true, + "type": "uuid" } ], "related": "listGpuCards", "response": [ + {}, + {}, { "description": "the vendor name of the GPU card", "name": "vendorname", "type": "string" }, - { - "description": "the device name of the GPU card", - "name": "devicename", - "type": "string" - }, { "description": "the vendor ID of the GPU card", "name": "vendorid", "type": "string" }, { - "description": "the ID of the GPU card", - "name": "id", + "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", + "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", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { "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 device ID of the GPU card", + "name": "deviceid", + "type": "string" + }, + { + "description": "the ID of the GPU card", + "name": "id", + "type": "string" + } ], "since": "4.21.0" }, @@ -40280,28 +40470,28 @@ } ], "response": [ + {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, + {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - {} + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } ], "since": "4.4.0" }, @@ -40322,71 +40512,31 @@ "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,createVMFromBackup,createVMFromBackup,assignVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", "required": true, "type": "uuid" } ], - "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,createVMFromBackup,createVMFromBackup,assignVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", "response": [ { - "description": "the group ID of the virtual machine", - "name": "groupid", - "type": "string" - }, - { - "description": "the state of the virtual machine", - "name": "state", - "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": "public IP address id associated with vm via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "User VM type", - "name": "vmtype", - "type": "string" - }, - { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" - }, - { - "description": "the VM's primary IP address", - "name": "ipaddress", + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the format of the template for the virtual machine", - "name": "templateformat", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", + "description": "Instance lease duration in days", + "name": "leaseduration", "type": "integer" }, { @@ -40395,181 +40545,100 @@ "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, - { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", "type": "long" }, { - "description": "Instance lease expiry date", - "name": "leaseexpirydate", - "type": "date" - }, - { - "description": "ssh key-pairs", - "name": "keypairs", - "type": "string" - }, - { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "User VM type", + "name": "vmtype", "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": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "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": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "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", - "name": "zoneid", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "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", + "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": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { "description": "list of security groups associated with the virtual machine", "name": "securitygroup", "response": [ { - "description": "the domain ID of the security group", - "name": "domainid", + "description": "the description of the security group", + "name": "description", "type": "string" }, { - "description": "the domain name of the security group", - "name": "domain", + "description": "the ID of the security group", + "name": "id", "type": "string" }, { - "description": "the project name of the group", - "name": "project", + "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", + "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 egress rules associated with the security group", "name": "egressrule", "response": [ - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, { "description": "the type of the ICMP message response", "name": "icmptype", "type": "integer" }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -40578,13 +40647,13 @@ "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": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -40593,8 +40662,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" }, { @@ -40603,43 +40672,88 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project name where tag belongs to", + "name": "project", "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", "type": "string" } ], "type": "set" + }, + { + "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", + "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 code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" } ], "type": "set" }, { - "description": "the name of the security group", - "name": "name", + "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 list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -40648,18 +40762,18 @@ "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": "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" }, { @@ -40667,14 +40781,19 @@ "name": "account", "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", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -40683,31 +40802,16 @@ "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" } ], "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", + "description": "path of the Domain the security group belongs to", + "name": "domainpath", "type": "string" }, { @@ -40715,23 +40819,13 @@ "name": "ingressrule", "response": [ { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "account owning the security group rule", - "name": "account", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { - "description": "the starting IP of the security group rule", - "name": "startport", + "description": "the ending IP of the security group rule ", + "name": "endport", "type": "integer" }, { @@ -40739,33 +40833,18 @@ "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", - "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": "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" }, { @@ -40774,33 +40853,33 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "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": "tag key name", - "name": "key", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { @@ -40809,163 +40888,387 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "id of the resource", + "name": "resourceid", "type": "string" } ], "type": "set" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", + "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 type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", "type": "integer" } ], "type": "set" }, { - "description": "path of the Domain the security group belongs to", + "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 domain ID of the security group", + "name": "domainid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" + }, + { + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, + { + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "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": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", "name": "domainpath", "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "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 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 vgpu profile to which service offering is linked", - "name": "vgpuprofilename", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "an 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": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the video RAM size in MB", + "name": "videoram", + "type": "long" + }, + { + "description": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" + }, + { + "description": "the user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" + }, + { + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, + { + "description": "VNF details", + "name": "vnfdetails", + "type": "map" + }, { "description": "the maximum number of display heads", "name": "maxheads", "type": "long" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "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 virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "the name of the gpu card to which service offering is linked", - "name": "gpucardname", + "description": "the format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "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 vGPU type used by the virtual machine", - "name": "vgpu", - "type": "string" + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "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": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "type": "string" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", + "description": "the memory used by the VM in KiB", + "name": "memorykbs", "type": "long" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", - "type": "string" + "description": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" }, - {}, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "Instance lease expiry action", - "name": "leaseexpiryaction", + "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": "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 domain ID of the affinity group", + "name": "domainid", + "type": "string" + }, + { + "description": "the project name of the affinity group", + "name": "project", + "type": "string" + }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "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" + }, + { + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" + }, + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "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": "true if vm has delete protection.", - "name": "deleteprotection", - "type": "boolean" + "description": "the VM's primary IP address", + "name": "ipaddress", + "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", "type": "string" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { @@ -40973,9 +41276,15 @@ "name": "haenable", "type": "boolean" }, + {}, + { + "description": "the maximum Y resolution", + "name": "maxresolutiony", + "type": "long" + }, { - "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" }, { @@ -40984,18 +41293,38 @@ "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "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 date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "the name of the virtual machine", + "name": "name", + "type": "string" + }, + { + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + { + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { @@ -41004,153 +41333,88 @@ "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", + "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", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", + "description": "the memory allocated for the virtual machine", + "name": "memory", "type": "integer" }, { - "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 type id of the vm", - "name": "ostypeid", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", + "type": "string" }, { - "description": "the project name of the vm", - "name": "project", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, + { + "description": "the count of GPUs on the virtual machine", + "name": "gpucount", + "type": "integer" + }, { "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", - "type": "string" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, { "description": "the name of the corresponding network", "name": "networkname", "type": "string" }, - { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" - }, { "description": "the 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": "the IPv6 address of network", - "name": "ip6address", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" }, { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { "description": "the broadcast uri of the nic", @@ -41158,33 +41422,33 @@ "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "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 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 isolation uri of the nic", - "name": "isolationuri", + "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": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { @@ -41193,164 +41457,172 @@ "type": "boolean" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" - }, - { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", - "type": "list" - }, - { - "description": "the description of the affinity group", - "name": "description", + "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": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the account owning the affinity group", - "name": "account", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the ID of the affinity group", - "name": "id", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the type of the affinity group", + "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", "type": "string" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", "type": "list" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" } ], "type": "set" }, + { + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + }, {}, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the video RAM size in MB", - "name": "videoram", - "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 maximum X resolution", - "name": "maxresolutionx", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" + }, + { + "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": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "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 project name of the vm", + "name": "project", "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", "type": "string" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "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": "the maximum X resolution", + "name": "maxresolutionx", "type": "long" }, { - "description": "the ID of the vgpu profile to which service offering is linked", - "name": "vgpuprofileid", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { @@ -41359,131 +41631,49 @@ "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": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the 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", + "description": "the speed of each vCPU", + "name": "cpuspeed", "type": "integer" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" - }, - { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "the name of the template for the virtual machine", + "name": "templatename", "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": "public IP address id associated with vm via Static nat rule", + "name": "publicip", + "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", + "type": "string" } ] }, @@ -41493,47 +41683,46 @@ "name": "updateCustomAction", "params": [ { - "description": "Type of the resource for actions", + "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": "resourcetype", + "name": "parameters", "required": false, - "type": "string" + "type": "map" }, { - "description": "Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].vendor=xxx&&details[0].version=2.0", + "description": "Optional boolean field, which indicates if parameters should be cleaned up or not (If set to true, parameters will be removed for this action, parameters field ignored; if false or not set, no action)", "length": 255, - "name": "details", + "name": "cleanupparameters", "required": false, - "type": "map" + "type": "boolean" }, { - "description": "The description of the command", + "description": "Whether the action is enabled or not", "length": 255, - "name": "description", + "name": "enabled", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "ID of the custom action", + "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": "id", - "related": "addCustomAction,listCustomActions", - "required": true, - "type": "uuid" + "name": "errormessage", + "required": false, + "type": "string" }, { - "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": "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": "successmessage", + "name": "cleanupdetails", "required": false, - "type": "string" + "type": "boolean" }, { - "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)", + "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": "cleanupparameters", + "name": "details", "required": false, - "type": "boolean" + "type": "map" }, { "description": "List of role types allowed for the action", @@ -41543,63 +41732,64 @@ "type": "list" }, { - "description": "Whether the action is enabled or not", + "description": "Specifies the timeout in seconds to wait for the action to complete before failing. Default value is 3 seconds", "length": 255, - "name": "enabled", + "name": "timeout", "required": false, - "type": "boolean" + "type": "integer" }, { - "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": "Type of the resource for actions", "length": 255, - "name": "errormessage", + "name": "resourcetype", "required": false, "type": "string" }, { - "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": "The description of the command", "length": 255, - "name": "cleanupdetails", + "name": "description", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "Specifies the timeout in seconds to wait for the action to complete before failing. Default value is 3 seconds", + "description": "ID of the custom action", "length": 255, - "name": "timeout", - "required": false, - "type": "integer" + "name": "id", + "related": "addCustomAction,listCustomActions", + "required": true, + "type": "uuid" }, { - "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": "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": "parameters", + "name": "successmessage", "required": false, - "type": "map" + "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": "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.21.0" @@ -41619,26 +41809,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", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" } ] @@ -41648,13 +41838,6 @@ "isasync": false, "name": "executeWebhookDelivery", "params": [ - { - "description": "Payload of the Webhook delivery", - "length": 255, - "name": "payload", - "required": false, - "type": "string" - }, { "description": "The ID of the Webhook", "length": 255, @@ -41664,9 +41847,9 @@ "type": "uuid" }, { - "description": "Secret key of the Webhook delivery", + "description": "Payload of the Webhook delivery", "length": 255, - "name": "secretkey", + "name": "payload", "required": false, "type": "string" }, @@ -41677,6 +41860,13 @@ "required": false, "type": "boolean" }, + { + "description": "Secret key of the Webhook delivery", + "length": 255, + "name": "secretkey", + "required": false, + "type": "string" + }, { "description": "Payload URL of the Webhook delivery", "length": 255, @@ -41696,40 +41886,35 @@ "related": "", "response": [ { - "description": "The ID of the event", - "name": "eventid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "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 payload of the webhook delivery", - "name": "payload", + "description": "The name of the Webhook", + "name": "webhookname", "type": "string" }, { - "description": "The start time of the Webhook delivery", - "name": "startdate", - "type": "date" + "description": "The ID of the management server which executed delivery", + "name": "managementserverid", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The response of the webhook delivery", + "name": "response", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The ID of the Webhook", + "name": "webhookid", + "type": "string" }, { "description": "The end time of the Webhook delivery", @@ -41737,18 +41922,13 @@ "type": "date" }, { - "description": "The ID of the Webhook delivery", - "name": "id", - "type": "string" - }, - { - "description": "The type of the event", - "name": "eventtype", + "description": "The payload of the webhook delivery", + "name": "payload", "type": "string" }, { - "description": "The ID of the Webhook", - "name": "webhookid", + "description": "The ID of the Webhook delivery", + "name": "id", "type": "string" }, { @@ -41756,21 +41936,31 @@ "name": "headers", "type": "string" }, + { + "description": "Whether Webhook delivery succeeded or not", + "name": "success", + "type": "boolean" + }, {}, { - "description": "The ID of the management server which executed delivery", - "name": "managementserverid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "The response of the webhook delivery", - "name": "response", + "description": "The ID of the event", + "name": "eventid", "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" @@ -41790,28 +41980,28 @@ } ], "response": [ + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "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" + } ] }, { @@ -41820,19 +42010,19 @@ "name": "listTungstenFabricProviders", "params": [ { - "description": "", + "description": "List by keyword", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "integer" + "type": "uuid" }, { "description": "", @@ -41842,21 +42032,15 @@ "type": "integer" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" } ], "related": "createTungstenFabricProvider", "response": [ - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "true if security groups support is enabled, false otherwise", "name": "securitygroupsenabled", @@ -41868,21 +42052,22 @@ "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": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, {}, { - "description": "Tungsten-Fabric provider introspect port", - "name": "tungstenproviderintrospectport", - "type": "string" + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" }, + {}, { "description": "Tungsten-Fabric provider zone name", "name": "zonename", @@ -41893,21 +42078,26 @@ "name": "tungstengateway", "type": "string" }, - { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" - }, { "description": "Tungsten-Fabric provider port", "name": "tungstenproviderport", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "Tungsten-Fabric provider name", "name": "name", "type": "string" }, + { + "description": "Tungsten-Fabric provider vrouter port", + "name": "tungstenprovidervrouterport", + "type": "string" + }, { "description": "Tungsten-Fabric provider hostname", "name": "tungstenproviderhostname", @@ -41921,46 +42111,46 @@ "name": "listDeploymentPlanners", "params": [ { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" } ], "related": "", "response": [ - {}, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Deployment Planner name", + "name": "name", "type": "string" }, + {}, { - "description": "Deployment Planner 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", "type": "integer" - } + }, + {} ] }, { @@ -41978,27 +42168,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": "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" } ] }, @@ -42011,76 +42201,67 @@ "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", + "description": "the last time this host was annotated", + "name": "lastannotated", "type": "date" }, { - "description": "the ID of the host", - "name": "id", - "type": "string" - }, - { - "description": "the CPU speed of the host", - "name": "cpuspeed", + "description": "Used GPUs on the Host", + "name": "gpuused", "type": "long" }, { - "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 name of extension for this cluster", - "name": "extensionname", + "description": "The ID of extension for this cluster", + "name": "extensionid", "type": "string" }, + {}, { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", + "description": "the CPU speed of the host", + "name": "cpuspeed", "type": "long" }, { - "description": "the host type", - "name": "type", - "type": "type" - }, - { - "description": "the state of the host", - "name": "state", - "type": "status" + "description": "the amount of the host's memory currently used", + "name": "memoryused", + "type": "long" }, { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", - "type": "string" + "description": "the cpu average load on the host", + "name": "cpuloadaverage", + "type": "double" }, { - "description": "true if the host supports encryption", - "name": "encryptionsupported", + "description": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", "type": "boolean" }, { - "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", + "description": "comma-separated list of storage access groups on the pod", + "name": "podstorageaccessgroups", "type": "string" }, { - "description": "comma-separated list of storage access groups for the host", - "name": "storageaccessgroups", + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", "type": "string" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", + "description": "the amount of the host's memory currently allocated in bytes", + "name": "memoryallocatedbytes", "type": "long" }, { @@ -42088,145 +42269,120 @@ "name": "managementservername", "type": "string" }, + {}, { - "description": "the cluster ID of the host", - "name": "clusterid", + "description": "the number of CPU sockets on the host", + "name": "cpusockets", + "type": "integer" + }, + { + "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", "type": "string" }, { - "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", - "name": "hasenoughcapacity", + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", + "type": "string" + }, + { + "description": "true if the host supports instance conversion (using virt-v2v)", + "name": "instanceconversionsupported", "type": "boolean" }, + { + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", + "type": "long" + }, + { + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", + "type": "long" + }, + { + "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": "the Zone ID of the host", - "name": "zoneid", + "description": "the host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the number of CPU sockets on the host", - "name": "cpusockets", - "type": "integer" + "description": "the amount of the host's CPU currently used", + "name": "cpuused", + "type": "string" }, { - "description": "the hypervisor version", - "name": "hypervisorversion", + "description": "the cluster name of the host", + "name": "clustername", "type": "string" }, { - "description": "GPU cards present in the host", - "name": "gpugroup", - "response": [ - { - "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", - "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": "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": "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 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", + "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", + "name": "cpuwithoverprovisioning", "type": "string" }, { - "description": "the virtual machine id for host type ConsoleProxy and SecondaryStorageVM", - "name": "virtualmachineid", + "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", - "type": "long" + "description": "the Zone name of the host", + "name": "zonename", + "type": "string" }, - {}, { - "description": "the Pod ID of the host", - "name": "podid", + "description": "the host version", + "name": "version", "type": "string" }, + { + "description": "the host type", + "name": "type", + "type": "type" + }, { "description": "comma-separated list of storage access groups on the zone", "name": "zonestorageaccessgroups", "type": "string" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" - }, - { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", + "description": "the cluster type of the cluster that host belongs to", + "name": "clustertype", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the date and time the host was created", + "name": "created", + "type": "date" }, { - "description": "the Pod name of the host", - "name": "podname", + "description": "comma-separated list of explicit host tags for the host", + "name": "explicithosttags", "type": "string" }, { @@ -42235,109 +42391,113 @@ "type": "integer" }, { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", - "type": "boolean" + "description": "the Pod ID of the host", + "name": "podid", + "type": "string" }, { - "description": "true if the host has capability to support UEFI boot", - "name": "ueficapability", + "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", + "name": "hasenoughcapacity", "type": "boolean" }, { - "description": "the Zone name of the host", - "name": "zonename", + "description": "the IP address of the host", + "name": "ipaddress", "type": "string" }, { - "description": "the management server ID of the host", - "name": "managementserverid", + "description": "the resource state of the host", + "name": "resourcestate", "type": "string" }, { - "description": "true if the host supports instance conversion (using virt-v2v)", - "name": "instanceconversionsupported", - "type": "boolean" + "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "name": "memorytotal", + "type": "long" }, { - "description": "the host hypervisor", - "name": "hypervisor", - "type": "string" + "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 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": "CPU Arch of the host", + "name": "arch", + "type": "string" }, - {}, { - "description": "the amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "capabilities of the host", - "name": "capabilities", + "description": "the last annotation set on this host by an admin", + "name": "annotation", "type": "string" }, { - "description": "the host version", - "name": "version", - "type": "string" + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" }, { - "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 last time this host was annotated", - "name": "lastannotated", - "type": "date" + "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", + "description": "true if the host supports encryption", + "name": "encryptionsupported", "type": "boolean" }, { - "description": "the resource state of the host", - "name": "resourcestate", + "description": "the management server ID of the host", + "name": "managementserverid", "type": "string" }, { - "description": "the cluster name of the host", - "name": "clustername", + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" + }, + { + "description": "the name of the host", + "name": "name", "type": "string" }, { - "description": "the amount of the host's memory currently used", - "name": "memoryused", + "description": "the amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", "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", + "type": "boolean" }, { - "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": "the host HA information information", + "name": "hostha", + "type": "hostharesponse" }, { - "description": "the OS category name of the host", - "name": "oscategoryname", + "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", "type": "string" }, { @@ -42346,63 +42506,133 @@ "type": "string" }, { - "description": "comma-separated list of storage access groups on the pod", - "name": "podstorageaccessgroups", + "description": "the OS category ID of the host", + "name": "oscategoryid", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", + "description": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", + "type": "string" + }, + { + "description": "comma-separated list of storage access groups for the host", + "name": "storageaccessgroups", "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", + "description": "the incoming network traffic on the host", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "the Pod name of the host", + "name": "podname", "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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the state of the host", + "name": "state", + "type": "status" }, { - "description": "the OS category ID of the host", - "name": "oscategoryid", + "description": "the Zone ID of the host", + "name": "zoneid", "type": "string" }, { - "description": "comma-separated list of tags for the host", - "name": "hosttags", + "description": "comma-separated list of implicit host tags for the host", + "name": "implicithosttags", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", - "type": "string" + "description": "Host details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "GPU cards present in the host", + "name": "gpugroup", + "response": [ + { + "description": "the list of enabled vGPUs", + "name": "vgpu", + "response": [ + { + "description": "Maximum X resolution per display", + "name": "maxresolutionx", + "type": "long" + }, + { + "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", + "name": "maxcapacity", + "type": "long" + }, + { + "description": "Maximum displays per user", + "name": "maxheads", + "type": "long" + }, + { + "description": "Maximum no. of vgpu per gpu card (pgpu)", + "name": "maxvgpuperpgpu", + "type": "long" + }, + { + "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", + "name": "remainingcapacity", + "type": "long" + }, + { + "description": "Model Name of vGPU", + "name": "vgputype", + "type": "string" + }, + { + "description": "Video RAM for this vGPU type", + "name": "videoram", + "type": "long" + }, + { + "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 amount of the host's memory after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", + "description": "the OS category name of the host", + "name": "oscategoryname", "type": "string" }, { - "description": "comma-separated list of explicit host tags for the host", - "name": "explicithosttags", + "description": "the hypervisor version", + "name": "hypervisorversion", "type": "string" }, { - "description": "The ID of extension for this cluster", - "name": "extensionid", + "description": "the host hypervisor", + "name": "hypervisor", "type": "string" }, { @@ -42411,54 +42641,14 @@ "type": "string" }, { - "description": "the host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" - }, - { - "description": "CPU Arch of the host", - "name": "arch", - "type": "string" - }, - { - "description": "events available for the host", - "name": "events", - "type": "string" - }, - { - "description": "the IP address of the host", - "name": "ipaddress", + "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 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": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", "type": "boolean" - }, - { - "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", - "type": "long" - }, - { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" - }, - { - "description": "Host details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "the host HA information information", - "name": "hostha", - "type": "hostharesponse" } ] }, @@ -42476,28 +42666,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": "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" - } + }, + {} ] }, { @@ -42515,23 +42705,23 @@ ], "related": "", "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "Volume iSCSI Name", "name": "volumeiScsiName", "type": "string" }, {}, - {}, + { + "description": "the UUID of the latest async 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" - } + }, + {} ] }, { @@ -42540,106 +42730,96 @@ "name": "updateAutoScaleVmGroup", "params": [ { - "description": "the name of the autoscale vmgroup", - "length": 255, - "name": "name", - "required": false, - "since": "4.18.0", - "type": "string" - }, - { - "description": "an optional field, whether to the display the group 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 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 scaleup autoscale policies", "length": 255, - "name": "id", - "related": "enableAutoScaleVmGroup,listAutoScaleVmGroups,updateAutoScaleVmGroup", - "required": true, - "type": "uuid" + "name": "scaleuppolicyids", + "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": "list of scaledown autoscale policies", "length": 255, - "name": "maxmembers", + "name": "scaledownpolicyids", + "related": "listAutoScalePolicies,updateAutoScalePolicy", "required": false, - "type": "integer" + "type": "list" }, { - "description": "list of scaleup autoscale policies", + "description": "an optional field, whether to the display the group to the end user or not", "length": 255, - "name": "scaleuppolicyids", - "related": "listAutoScalePolicies,updateAutoScalePolicy", + "name": "fordisplay", "required": false, - "type": "list" + "since": "4.4", + "type": "boolean" }, { - "description": "the frequency in which the performance counters to be collected", + "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": "interval", + "name": "maxmembers", "required": false, "type": "integer" }, { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "description": "the name of the autoscale vmgroup", "length": 255, - "name": "customid", + "name": "name", "required": false, - "since": "4.4", + "since": "4.18.0", "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" + }, + { + "description": "the ID of the autoscale group", + "length": 255, + "name": "id", + "related": "enableAutoScaleVmGroup,listAutoScaleVmGroups,updateAutoScaleVmGroup", + "required": true, + "type": "uuid" } ], "related": "enableAutoScaleVmGroup,listAutoScaleVmGroups", "response": [ - { - "description": "the frequency at which the conditions have to be evaluated", - "name": "interval", - "type": "int" - }, - { - "description": "is group for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, { "description": "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 domain ID of the vm group", + "name": "domainid", "type": "string" }, { - "description": "list of scaleup autoscale policies", - "name": "scaleuppolicies", + "description": "list of scaledown autoscale policies", + "name": "scaledownpolicies", "type": "list" }, { - "description": "the public ip address", - "name": "publicip", - "type": "string" + "description": "the frequency at which the conditions have to be evaluated", + "name": "interval", + "type": "int" }, { "description": "the lb provider of the guest network the lb rule belongs to", @@ -42647,19 +42827,35 @@ "type": "string" }, { - "description": "the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number.", - "name": "maxmembers", + "description": "the number of available virtual machines (in Running, Starting, Stopping or Migrating state) in the vmgroup", + "name": "availablevirtualmachinecount", "type": "int" }, + {}, { "description": "the autoscale vm group ID", "name": "id", "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": "is group 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 domain name of the vm group", + "name": "domain", + "type": "string" }, { "description": "the project name of the vm group", @@ -42667,19 +42863,19 @@ "type": "string" }, { - "description": "the project id of the vm group", - "name": "projectid", + "description": "the name of the guest network the lb rule belongs to", + "name": "associatednetworkname", "type": "string" }, { - "description": "list of scaledown autoscale policies", - "name": "scaledownpolicies", - "type": "list" + "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 public port", - "name": "publicport", - "type": "string" + "description": "the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number.", + "name": "maxmembers", + "type": "int" }, { "description": "the account owning the vm group", @@ -42687,75 +42883,69 @@ "type": "string" }, { - "description": "the current state of the AutoScale Vm Group", - "name": "state", - "type": "string" + "description": "list of scaleup autoscale policies", + "name": "scaleuppolicies", + "type": "list" }, { - "description": "the domain name of the vm group", - "name": "domain", - "type": "string" + "description": "the date when this vm group was created", + "name": "created", + "type": "date" }, { - "description": "the name of the autoscale vm group ", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, {}, { - "description": "path of the domain to which the vm group belongs", - "name": "domainpath", + "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 name of the guest network the lb rule belongs to", - "name": "associatednetworkname", + "description": "the load balancer rule ID", + "name": "lbruleid", "type": "string" }, { - "description": "the id of the guest network the lb rule belongs to", - "name": "associatednetworkid", + "description": "the public port", + "name": "publicport", "type": "string" }, { - "description": "the private port", - "name": "privateport", + "description": "the name of the autoscale vm group ", + "name": "name", "type": "string" }, { - "description": "the autoscale profile that contains information about the vms in the vm group.", - "name": "vmprofileid", + "description": "the public ip address id", + "name": "publicipid", "type": "string" }, - {}, { - "description": "the public ip address id", - "name": "publicipid", + "description": "the private port", + "name": "privateport", "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 current state of the AutoScale Vm Group", + "name": "state", + "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": "the date when this vm group was created", - "name": "created", - "type": "date" + "description": "the public ip address", + "name": "publicip", + "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" } ] @@ -42784,28 +42974,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": "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" - } + {}, + {} ] }, { @@ -42814,90 +43004,54 @@ "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)", - "length": 255, - "name": "name", - "required": false, - "type": "string" - }, - { - "description": "the IDs of the virtual machines, mutually exclusive with id", + "description": "the host ID", "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": "hostid", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost", "required": false, - "since": "4.4", - "type": "list" + "type": "uuid" }, { - "description": "list by the High Availability offering; true if filtering VMs with HA enabled; false for VMs with HA disabled", + "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": "haenable", + "name": "state", "required": false, - "since": "4.15", - "type": "boolean" + "type": "string" }, { - "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": "", "length": 255, - "name": "gpuenabled", + "name": "page", "required": false, - "since": "4.21.0", - "type": "boolean" + "type": "integer" }, { - "description": "the availability zone ID", + "description": "list vms by iso", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "isoid", "required": false, "type": "uuid" }, { - "description": "flag to list vms created from VNF templates (as known as VNF appliances) or not; true if need to list VNF appliances, false otherwise.", + "description": "", "length": 255, - "name": "isvnf", + "name": "pagesize", "required": false, - "since": "4.19.0", - "type": "boolean" + "type": "integer" }, { - "description": "Whether to return the VMs' user data or not. By default, user data will not be returned.", + "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": "userdata", + "name": "accumulate", "required": false, - "since": "4.18.0.0", + "since": "4.17.0", "type": "boolean" }, { "description": "list vms by template", "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", - "required": false, - "type": "uuid" - }, - { - "description": "List resources by tags (key/value pairs)", - "length": 255, - "name": "tags", - "required": false, - "type": "map" - }, - { - "description": "the cluster ID", - "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", - "required": false, - "since": "4.16.0", - "type": "uuid" - }, - { - "description": "list objects by project; if projectid=-1 lists All VMs", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "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" }, @@ -42910,65 +43064,58 @@ "type": "uuid" }, { - "description": "the user ID that created the VM and is under the account that owns the VM", - "length": 255, - "name": "userid", - "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", - "required": false, - "type": "uuid" - }, - { - "description": "list by the service offering", + "description": "makes the API's response contains only the resource count", "length": 255, - "name": "serviceofferingid", - "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", + "name": "retrieveonlyresourcecount", "required": false, - "since": "4.4", - "type": "uuid" + "type": "boolean" }, { - "description": "state of the virtual machine. Possible values are: Running, Stopped, Present, Destroyed, Expunged. Present is used for the state equal not destroyed.", + "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": "state", + "name": "details", "required": false, - "type": "string" + "type": "list" }, { - "description": "Whether to return only leased instances", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "leased", + "name": "displayvm", "required": false, - "since": "4.21.0", + "since": "4.4", "type": "boolean" }, { - "description": "list by network type; true if need to list vms using Virtual Network, false otherwise", + "description": "the group ID", "length": 255, - "name": "forvirtualnetwork", + "name": "groupid", + "related": "createInstanceGroup,updateInstanceGroup", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "list vms by ssh keypair name", + "description": "list vms by affinity group", "length": 255, - "name": "keypair", + "name": "affinitygroupid", + "related": "createAffinityGroup,listAffinityGroups", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "comma separated list of vm details requested, value can be a list of [all, group, nics, stats, secgrp, tmpl, servoff, diskoff, backoff, iso, volume, min, affgrp]. When no parameters are passed, all the details are returned if list.vm.default.details.stats is true (default), otherwise when list.vm.default.details.stats is false the API response will exclude the stats details.", + "description": "list by the High Availability offering; true if filtering VMs with HA enabled; false for VMs with HA disabled", "length": 255, - "name": "details", + "name": "haenable", "required": false, - "type": "list" + "since": "4.15", + "type": "boolean" }, { - "description": "the instances by userdata", + "description": "list by the backup offering", "length": 255, - "name": "userdataid", - "related": "listCniConfiguration", + "name": "backupofferingid", + "related": "listBackupProviderOfferings,importBackupOffering,listBackupOfferings,updateBackupOffering", "required": false, - "since": "4.20.1", + "since": "4.17", "type": "uuid" }, { @@ -42981,34 +43128,28 @@ "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", + "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": "arch", + "name": "isvnf", "required": false, - "since": "4.20.1", - "type": "string" + "since": "4.19.0", + "type": "boolean" }, { - "description": "the ID of the virtual machine", + "description": "list by the service offering", "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": "serviceofferingid", + "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", "required": false, + "since": "4.4", "type": "uuid" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "Whether to return only leased instances", "length": 255, - "name": "listall", + "name": "leased", "required": false, + "since": "4.21.0", "type": "boolean" }, { @@ -43020,6 +43161,14 @@ "since": "4.21.0", "type": "uuid" }, + { + "description": "Whether to return the VMs' user data or not. By default, user data will not be returned.", + "length": 255, + "name": "userdata", + "required": false, + "since": "4.18.0.0", + "type": "boolean" + }, { "description": "the target hypervisor for the template", "length": 255, @@ -43028,704 +43177,292 @@ "type": "string" }, { - "description": "List by keyword", + "description": "list by network id", "length": 255, - "name": "keyword", + "name": "networkid", + "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "makes the API's response contains only the resource count", + "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": "retrieveonlyresourcecount", + "name": "gpuenabled", "required": false, + "since": "4.21.0", "type": "boolean" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "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": "account", + "name": "name", "required": false, "type": "string" }, { - "description": "", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "pagesize", + "name": "tags", "required": false, - "type": "integer" + "type": "map" }, { - "description": "the pod ID", + "description": "List by keyword", "length": 255, - "name": "podid", - "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the storage ID where vm's volumes belong to", + "description": "the user ID that created the VM and is under the account that owns the VM", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "name": "userid", + "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", "required": false, "type": "uuid" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "the pod ID", "length": 255, - "name": "displayvm", + "name": "podid", + "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", "required": false, - "since": "4.4", - "type": "boolean" + "type": "uuid" }, { - "description": "list by the backup offering", + "description": "the availability zone ID", "length": 255, - "name": "backupofferingid", - "related": "listBackupProviderOfferings,importBackupOffering,listBackupOfferings,updateBackupOffering", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "since": "4.17", "type": "uuid" }, { - "description": "the group ID", + "description": "the cluster ID", "length": 255, - "name": "groupid", - "related": "createInstanceGroup,updateInstanceGroup", + "name": "clusterid", + "related": "addCluster,updateCluster", "required": false, + "since": "4.16.0", "type": "uuid" }, { - "description": "Accumulates the VM metrics data instead of returning only the most recent data collected. The default behavior is set by the global configuration vm.stats.increment.metrics.", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "accumulate", + "name": "isrecursive", "required": false, - "since": "4.17.0", "type": "boolean" }, { - "description": "the host ID", - "length": 255, - "name": "hostid", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost,addBaremetalHost", - "required": false, - "type": "uuid" - }, - { - "description": "", + "description": "the IDs of the virtual machines, mutually exclusive with id", "length": 255, - "name": "page", + "name": "ids", + "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,createVMFromBackup,createVMFromBackup,assignVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", "required": false, - "type": "integer" + "since": "4.4", + "type": "list" }, { - "description": "the ID of AutoScaling VM Group", + "description": "the storage ID where vm's volumes belong to", "length": 255, - "name": "autoscalevmgroupid", - "related": "enableAutoScaleVmGroup,listAutoScaleVmGroups", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", "required": false, - "since": "4.18.0", "type": "uuid" }, { - "description": "list vms by affinity group", + "description": "the ID of the virtual machine", "length": 255, - "name": "affinitygroupid", - "related": "createAffinityGroup,listAffinityGroups", + "name": "id", + "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,createVMFromBackup,createVMFromBackup,assignVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", "required": false, "type": "uuid" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "isrecursive", + "name": "account", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "list by network id", + "description": "list vms by vpc", "length": 255, - "name": "networkid", - "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "vpcid", + "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", "required": false, "type": "uuid" }, { - "description": "list vms by iso", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "isoid", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, "type": "uuid" }, - { - "description": "flag to display the resource icon for VMs", - "length": 255, - "name": "showicon", - "required": false, - "since": "4.16.0.0", - "type": "boolean" - } - ], - "related": "assignVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", - "response": [ - { - "description": "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", + "length": 255, "name": "arch", + "required": false, + "since": "4.20.1", "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", - "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", + "description": "list vms by ssh keypair name", + "length": 255, + "name": "keypair", + "required": false, "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources 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": "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", - "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", - "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", + "description": "the ID of AutoScaling VM Group", + "length": 255, "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" + "related": "enableAutoScaleVmGroup,listAutoScaleVmGroups", + "required": false, + "since": "4.18.0", + "type": "uuid" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" + "description": "the instances by userdata", + "length": 255, + "name": "userdataid", + "related": "listCniConfiguration", + "required": false, + "since": "4.20.1", + "type": "uuid" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" + "description": "flag to display the resource icon for VMs", + "length": 255, + "name": "showicon", + "required": false, + "since": "4.16.0.0", + "type": "boolean" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" - }, + "description": "list by network type; true if need to list vms using Virtual Network, false otherwise", + "length": 255, + "name": "forvirtualnetwork", + "required": false, + "type": "boolean" + } + ], + "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,createVMFromBackup,createVMFromBackup,assignVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", + "response": [ { "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 date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "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 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": "Os type ID of the virtual machine", + "name": "guestosid", + "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": "path of the Domain associated with the tag", - "name": "domainpath", + "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": "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 project name where tag belongs to", - "name": "project", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "the domain associated with the tag", + "description": "the domain name of the affinity group", "name": "domain", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "tag value", - "name": "value", - "type": "string" + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the name of the affinity group", + "name": "name", "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", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { @@ -43734,48 +43471,43 @@ "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 id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "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": "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 extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the type of the nic", + "name": "type", "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" }, { @@ -43784,23 +43516,33 @@ "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { @@ -43809,13 +43551,18 @@ "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "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" }, { @@ -43824,8 +43571,8 @@ "type": "list" }, { - "description": "the ID of the nic", - "name": "id", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { @@ -43834,81 +43581,86 @@ "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", + "description": "the ID of the nic", + "name": "id", "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 isolated private VLAN type if available", - "name": "isolatedpvlantype", + "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": "the ip address of the nic", - "name": "ipaddress", + "description": "the name of the corresponding network", + "name": "networkname", "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": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" } ], "type": "set" }, { - "description": "the ID of the virtual machine", - "name": "id", + "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", - "type": "boolean" + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "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 memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, + { + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "the maximum number of display heads", - "name": "maxheads", - "type": "long" + "description": "Guest vm Boot Type", + "name": "boottype", + "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "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" }, { @@ -43917,24 +43669,44 @@ "type": "string" }, { - "description": "the count of GPUs on the virtual machine", - "name": "gpucount", + "description": "the type of the template for the virtual machine", + "name": "templatetype", + "type": "string" + }, + { + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "Instance lease duration in days", + "name": "leaseduration", "type": "integer" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the maximum number of display heads", + "name": "maxheads", + "type": "long" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" }, { "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", @@ -43942,36 +43714,192 @@ "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "the name of the virtual machine", + "name": "name", + "type": "string" + }, + { + "description": "Base64 string containing the user data", + "name": "userdata", + "type": "string" + }, + { + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, - {}, {}, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "the VM's primary IP address", + "name": "ipaddress", + "type": "string" + }, + { + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "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 security groups associated with the virtual machine", - "name": "securitygroup", + "description": "ssh key-pairs", + "name": "keypairs", + "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": "Instance lease expiry action", + "name": "leaseexpiryaction", + "type": "string" + }, + { + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", + "type": "string" + }, + { + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", + "type": "string" + }, + { + "description": "the id of userdata used for the VM", + "name": "userdataid", + "type": "string" + }, + { + "description": "VNF details", + "name": "vnfdetails", + "type": "map" + }, + { + "description": "the name of the host for the virtual machine", + "name": "hostname", + "type": "string" + }, + { + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, + { + "description": "CPU arch of the VM", + "name": "arch", + "type": "string" + }, + { + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" + }, + { + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", + "type": "string" + }, + { + "description": "the list of resource tags associated", + "name": "tags", "response": [ { - "description": "the domain ID of the security group", - "name": "domainid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "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 account owning the security group", + "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 account associated with the tag", "name": "account", "type": "string" }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", + "type": "string" + }, + { + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", + "response": [ + { + "description": "the description of the security group", + "name": "description", + "type": "string" + }, { "description": "the list of egress rules associated with the security group", "name": "egressrule", @@ -43982,8 +43910,18 @@ "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": "security group name", + "name": "securitygroupname", "type": "string" }, { @@ -43991,23 +43929,18 @@ "name": "tags", "response": [ { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project 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" }, { @@ -44016,23 +43949,23 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "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 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": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -44041,36 +43974,26 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", "type": "string" } ], "type": "set" }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, { "description": "the ending IP of the security group rule ", "name": "endport", "type": "integer" }, { - "description": "security group name", - "name": "securitygroupname", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, { @@ -44082,30 +44005,15 @@ "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" } ], "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", @@ -44115,81 +44023,81 @@ "name": "endport", "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 list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "tag key name", - "name": "key", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "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": "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 project id the tag belongs to", - "name": "projectid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "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": "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 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" } ], "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": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, { @@ -44203,35 +44111,40 @@ "type": "integer" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" + "description": "security group name", + "name": "securitygroupname", + "type": "string" }, { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" }, { - "description": "security group name", - "name": "securitygroupname", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" } ], "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 list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "id of the resource", - "name": "resourceid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { @@ -44240,33 +44153,33 @@ "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": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -44275,54 +44188,331 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "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" } ], "type": "set" }, { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", + "description": "the domain ID of the security group", + "name": "domainid", "type": "string" }, { - "description": "the project name of the group", - "name": "project", + "description": "the project id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "the 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 number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the name of the security group", + "name": "name", + "type": "string" } ], "type": "set" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "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 name of userdata used for the VM", + "name": "userdataname", + "type": "string" + }, + { + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" + }, + { + "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 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 read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", + "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": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "User VM type", + "name": "vmtype", + "type": "string" + }, + { + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" + }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" + }, + { + "description": "the count of GPUs on the virtual machine", + "name": "gpucount", + "type": "integer" + }, + { + "description": "the format of the template for the virtual machine", + "name": "templateformat", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "the ID of the host for the virtual machine", + "name": "hostid", + "type": "string" + }, + { + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" + }, + { + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" + }, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" + }, + { + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" + }, + { + "description": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" + }, + { + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "the state of the virtual machine", + "name": "state", + "type": "string" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" + }, + { + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", + "type": "string" + }, + { + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, + { + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", + "type": "string" + }, + { + "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": "the maximum X resolution", + "name": "maxresolutionx", + "type": "long" + }, + { + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + { + "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", + "type": "string" + }, + { + "description": "the ID of the virtual machine", + "name": "id", + "type": "string" + }, + { + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + { + "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": "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", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "Guest vm Boot Mode", + "name": "bootmode", "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" } ] @@ -44333,12 +44523,11 @@ "name": "listDiskOfferings", "params": [ { - "description": "The ID of the volume, tags of the volume are used to filter the offerings", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "volumeid", - "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, - "since": "4.17", "type": "uuid" }, { @@ -44349,59 +44538,53 @@ "type": "string" }, { - "description": "id of zone disk offering is associated with", + "description": "", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "pagesize", "required": false, - "since": "4.13", - "type": "uuid" + "type": "integer" }, { - "description": "name of the disk offering", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "name", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "The ID of a virtual machine. Pass this in if you want to see the suitable disk offering that can be used to create and add a disk to the virtual machine. Suitability is returned with suitableforvirtualmachine flag in the response", + "description": "The ID of the storage pool, tags of the storage pool are used to filter the offerings", "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", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", "required": false, - "since": "4.20.0", + "since": "4.17", "type": "uuid" }, { - "description": "Filter by state of the disk offering. Defaults to 'Active'. If set to 'all' shows both Active & Inactive offerings.", + "description": "listed offerings support disk encryption", "length": 255, - "name": "state", + "name": "encrypt", "required": false, - "since": "4.19", - "type": "string" + "since": "4.18", + "type": "boolean" }, { - "description": "list only resources belonging to the domain specified", + "description": "The ID of the volume, tags of the volume are used to filter the offerings", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "name": "volumeid", + "related": "importVolume,attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", "required": false, + "since": "4.17", "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", + "description": "The ID of a virtual machine. Pass this in if you want to see the suitable disk offering that can be used to create and add a disk to the virtual machine. Suitability is returned with suitableforvirtualmachine flag in the response", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "virtualmachineid", + "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,createVMFromBackup,createVMFromBackup,assignVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", "required": false, + "since": "4.20.0", "type": "uuid" }, { @@ -44412,50 +44595,50 @@ "type": "boolean" }, { - "description": "The ID of the storage pool, tags of the storage pool are used to filter the offerings", + "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,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "name": "isrecursive", "required": false, - "since": "4.17", - "type": "uuid" + "type": "boolean" }, { - "description": "", + "description": "the storage type of the service offering. Values are local and shared.", "length": 255, - "name": "page", + "name": "storagetype", "required": false, - "type": "integer" + "since": "4.19", + "type": "string" }, { - "description": "", + "description": "id of zone disk offering is associated with", "length": 255, - "name": "pagesize", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "integer" + "since": "4.13", + "type": "uuid" }, { - "description": "the storage type of the service offering. Values are local and shared.", + "description": "name of the disk offering", "length": 255, - "name": "storagetype", + "name": "name", "required": false, - "since": "4.19", "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 account. Must be used with the domainId parameter.", "length": 255, - "name": "isrecursive", + "name": "account", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "listed offerings support disk encryption", + "description": "Filter by state of the disk offering. Defaults to 'Active'. If set to 'all' shows both Active & Inactive offerings.", "length": 255, - "name": "encrypt", + "name": "state", "required": false, - "since": "4.18", - "type": "boolean" + "since": "4.19", + "type": "string" }, { "description": "ID of the disk offering", @@ -44464,29 +44647,21 @@ "related": "createDiskOffering,listDiskOfferings", "required": false, "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" } ], "related": "createDiskOffering", "response": [ { - "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", - "name": "provisioningtype", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "unique ID of the disk offering", - "name": "id", - "type": "string" - }, - { - "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domain", - "type": "string" + "description": "true if disk offering uses custom iops, false otherwise", + "name": "iscustomizediops", + "type": "boolean" }, { "description": "bytes write rate of the disk offering", @@ -44494,49 +44669,49 @@ "type": "long" }, { - "description": "the size of the disk offering in GB", - "name": "disksize", + "description": "bytes read rate of the disk offering", + "name": "diskBytesReadRate", "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "length (in second) of the burst", + "name": "diskIopsReadRateMaxLength", + "type": "long" }, { - "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" }, { - "description": "burst io requests write rate of the disk offering", - "name": "diskIopsWriteRateMax", + "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 storage type for this disk offering", - "name": "storagetype", + "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", + "name": "provisioningtype", "type": "string" }, { - "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": "length (in seconds) of the burst", - "name": "diskBytesReadRateMaxLength", - "type": "long" + "description": "the name of the disk offering", + "name": "name", + "type": "string" }, { - "description": "additional key/value details tied with this disk offering", - "name": "details", - "type": "map" + "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 size, false otherwise", @@ -44544,131 +44719,146 @@ "type": "boolean" }, { - "description": "bytes read rate of the disk offering", - "name": "diskBytesReadRate", + "description": "the max iops of the disk offering", + "name": "maxiops", "type": "long" }, {}, { - "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zone", + "description": "state of the disk offering", + "name": "state", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "additional key/value details tied with this disk offering", + "name": "details", + "type": "map" }, { - "description": "io requests read rate of the disk offering", - "name": "diskIopsReadRate", - "type": "long" + "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zoneid", + "type": "string" }, { - "description": "an alternate display text of the disk offering.", - "name": "displaytext", + "description": "the vsphere storage policy tagged to the disk offering in case of VMware", + "name": "vspherestoragepolicy", "type": "string" }, { - "description": "true if disk offering uses custom iops, false otherwise", - "name": "iscustomizediops", - "type": "boolean" + "description": "burst io requests read rate of the disk offering", + "name": "diskIopsReadRateMax", + "type": "long" + }, + { + "description": "length (in seconds) of the burst", + "name": "diskBytesWriteRateMaxLength", + "type": "long" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", + "name": "hypervisorsnapshotreserve", + "type": "integer" }, { "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", "name": "domainid", "type": "string" }, + { + "description": "io requests read rate of the disk offering", + "name": "diskIopsReadRate", + "type": "long" + }, + { + "description": "Whether disks using this offering will be encrypted on primary storage", + "name": "encrypt", + "type": "boolean" + }, + { + "description": "an alternate display text of the disk offering.", + "name": "displaytext", + "type": "string" + }, { "description": "io requests write rate of the disk offering", "name": "diskIopsWriteRate", "type": "long" }, { - "description": "the date this disk offering was created", - "name": "created", - "type": "date" + "description": "length (in seconds) of the burst", + "name": "diskIopsWriteRateMaxLength", + "type": "long" }, { - "description": "the min iops of the disk offering", - "name": "miniops", - "type": "long" + "description": "the tags for the disk offering", + "name": "tags", + "type": "string" }, { - "description": "the name of the disk 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": "Returns true if the disk offering is suitable for the given virtual machine for disk creation otherwise false", - "name": "suitableforvirtualmachine", + "description": "whether to display the offering to the end user or not.", + "name": "displayoffering", "type": "boolean" }, { - "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zoneid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "burst bytes read rate of the disk offering", - "name": "diskBytesReadRateMax", + "description": "burst bytes write rate of the disk offering", + "name": "diskBytesWriteRateMax", "type": "long" }, - { - "description": "state of the disk offering", - "name": "state", - "type": "string" - }, { "description": "length (in seconds) of the burst", - "name": "diskBytesWriteRateMaxLength", + "name": "diskBytesReadRateMaxLength", "type": "long" }, { - "description": "the cache mode to use for this disk offering. none, writeback or writethrough", - "name": "cacheMode", + "description": "unique ID of the disk offering", + "name": "id", "type": "string" }, { - "description": "the max iops of the disk offering", - "name": "maxiops", + "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": "diskIopsWriteRateMaxLength", + "description": "burst io requests write rate of the disk offering", + "name": "diskIopsWriteRateMax", "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 storage type for this disk offering", + "name": "storagetype", + "type": "string" }, { - "description": "the tags for the disk offering", - "name": "tags", - "type": "string" + "description": "the date this disk offering was created", + "name": "created", + "type": "date" }, {}, { - "description": "length (in second) of the burst", - "name": "diskIopsReadRateMaxLength", - "type": "long" + "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domain", + "type": "string" }, { - "description": "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": "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" } ] }, @@ -44687,16 +44877,15 @@ } ], "response": [ - {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, {}, { @@ -44705,10 +44894,11 @@ "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" + }, + {} ] }, { @@ -44717,18 +44907,18 @@ "name": "upgradeKubernetesCluster", "params": [ { - "description": "the ID of the Kubernetes cluster", + "description": "the ID of the Kubernetes version for upgrade", "length": 255, - "name": "id", - "related": "createKubernetesCluster,startKubernetesCluster,scaleKubernetesCluster,upgradeKubernetesCluster", + "name": "kubernetesversionid", + "related": "addKubernetesSupportedVersion,getUploadParamsForKubernetesSupportedVersion,listKubernetesSupportedVersions,updateKubernetesSupportedVersion", "required": true, "type": "uuid" }, { - "description": "the ID of the Kubernetes version for upgrade", + "description": "the ID of the Kubernetes cluster", "length": 255, - "name": "kubernetesversionid", - "related": "addKubernetesSupportedVersion,listKubernetesSupportedVersions,updateKubernetesSupportedVersion", + "name": "id", + "related": "createKubernetesCluster,startKubernetesCluster,scaleKubernetesCluster,upgradeKubernetesCluster", "required": true, "type": "uuid" } @@ -44736,1427 +44926,1884 @@ "related": "createKubernetesCluster,startKubernetesCluster,scaleKubernetesCluster", "response": [ { - "description": "the name of the domain in which the Kubernetes cluster exists", - "name": "domain", + "description": "Public IP Address ID of the cluster", + "name": "ipaddressid", "type": "string" }, { - "description": "URL end point for the Kubernetes cluster", - "name": "endpoint", + "description": "the type of the cluster", + "name": "clustertype", + "type": "clustertype" + }, + { + "description": "the ID of the service offering of the control nodes on the Kubernetes cluster", + "name": "controlofferingid", "type": "string" }, { - "description": "the ID of the template of the Kubernetes cluster", - "name": "templateid", + "description": "the description of the Kubernetes cluster", + "name": "description", + "type": "string" + }, + { + "description": "Name of CNI Configuration associated with the cluster", + "name": "cniconfigname", "type": "string" }, + { + "description": "the project name of the Kubernetes cluster", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the service offering of the etcd nodes on the Kubernetes cluster", + "name": "etcdofferingid", + "type": "string" + }, + { + "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": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + {}, + { + "description": "Maximum size of the cluster", + "name": "maxsize", + "type": "long" + }, + { + "description": "the state of the Kubernetes cluster", + "name": "state", + "type": "string" + }, + { + "description": "URL end point for the Kubernetes cluster dashboard UI", + "name": "consoleendpoint", + "type": "string" + }, + { + "description": "the control nodes count for the Kubernetes cluster", + "name": "controlnodes", + "type": "long" + }, { "description": "the date when this Kubernetes cluster was created", "name": "created", "type": "date" }, + { + "description": "the ID of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the ID of the template of the Kubernetes cluster", + "name": "templateid", + "type": "string" + }, + { + "description": "the name of the service offering of the worker nodes on the Kubernetes cluster", + "name": "workerofferingname", + "type": "string" + }, + { + "description": "Indicates if the CloudStack CSI driver has been setup in the cluster", + "name": "csienabled", + "type": "boolean" + }, + { + "description": "the name of the service offering of the Kubernetes cluster", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "the ID of the service offering of the worker nodes on the Kubernetes cluster", + "name": "workerofferingid", + "type": "string" + }, + { + "description": "the name of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionname", + "type": "string" + }, + { + "description": "the name of the domain in which the Kubernetes cluster exists", + "name": "domain", + "type": "string" + }, + { + "description": "the number of the etcd nodes on the Kubernetes cluster", + "name": "etcdnodes", + "type": "long" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the project id of the Kubernetes cluster", + "name": "projectid", + "type": "string" + }, + { + "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": "Whether autoscaling is enabled for the cluster", + "name": "autoscalingenabled", + "type": "boolean" + }, + { + "description": "the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", + "name": "masternodes", + "type": "long" + }, + { + "description": "Minimum size of the cluster", + "name": "minsize", + "type": "long" + }, + { + "description": "the name of the zone of the Kubernetes cluster", + "name": "zonename", + "type": "string" + }, + { + "description": "the name of the service offering of the etcd nodes on the Kubernetes cluster", + "name": "etcdofferingname", + "type": "string" + }, + { + "description": "the account associated with the Kubernetes cluster", + "name": "account", + "type": "string" + }, + { + "description": "the id of the Kubernetes cluster", + "name": "id", + "type": "string" + }, + { + "description": "keypair details", + "name": "keypair", + "type": "string" + }, + { + "description": "the name of the network of the Kubernetes cluster", + "name": "associatednetworkname", + "type": "string" + }, + { + "description": "Public IP Address of the cluster", + "name": "ipaddress", + "type": "string" + }, + { + "description": "Public IP Addresses of the etcd nodes", + "name": "etcdips", + "type": "map" + }, + { + "description": "the name of the service offering of the control nodes on the Kubernetes cluster", + "name": "controlofferingname", + "type": "string" + }, { "description": "the cpu cores of the Kubernetes cluster", "name": "cpunumber", "type": "string" }, + { + "description": "the ID of the domain in which the Kubernetes cluster exists", + "name": "domainid", + "type": "string" + }, + { + "description": "the ID of the service offering of the Kubernetes cluster", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "the ID of the network of the Kubernetes cluster", + "name": "networkid", + "type": "string" + }, + {}, + { + "description": "URL end point for the Kubernetes cluster", + "name": "endpoint", + "type": "string" + }, + { + "description": "the size (worker nodes count) of the Kubernetes cluster", + "name": "size", + "type": "long" + }, { "description": "the memory the Kubernetes cluster", "name": "memory", "type": "string" + } + ] + }, + { + "description": "Creates a condition for VM auto scaling", + "isasync": true, + "name": "createCondition", + "params": [ + { + "description": "Value for which the Counter will be evaluated with the Operator selected.", + "length": 255, + "name": "threshold", + "required": true, + "type": "long" }, { - "description": "the ID of the service offering of the etcd nodes on the Kubernetes cluster", - "name": "etcdofferingid", + "description": "the account of the condition. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "keypair details", - "name": "keypair", + "description": "the domain ID of the account.", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "required": false, + "type": "uuid" + }, + { + "description": "ID of the Counter.", + "length": 255, + "name": "counterid", + "related": "createCounter,listCounters", + "required": true, + "type": "uuid" + }, + { + "description": "an optional project for condition", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "uuid" + }, + { + "description": "Relational Operator to be used with threshold. Valid values are EQ, GT, LT, GE, LE.", + "length": 255, + "name": "relationaloperator", + "required": true, + "type": "string" + } + ], + "related": "listConditions", + "response": [ + { + "description": "Threshold Value for the counter.", + "name": "threshold", + "type": "long" + }, + { + "description": "the Name of the Counter.", + "name": "countername", + "type": "string" + }, + { + "description": "Details of the Counter.", + "name": "counter", + "type": "counterresponse" + }, + { + "description": "the domain id of the Condition owner", + "name": "domainid", + "type": "string" + }, + { + "description": "the project name of the Condition", + "name": "project", + "type": "string" + }, + { + "description": "Relational Operator to be used with threshold.", + "name": "relationaloperator", + "type": "string" + }, + { + "description": "the Id of the Counter.", + "name": "counterid", "type": "string" }, {}, { - "description": "the name of the service offering of the Kubernetes cluster", - "name": "serviceofferingname", + "description": "the domain name of the owner.", + "name": "domain", "type": "string" }, { - "description": "the account associated with the Kubernetes cluster", + "description": "the project id of the Condition.", + "name": "projectid", + "type": "string" + }, + { + "description": "the id of the Condition", + "name": "id", + "type": "string" + }, + { + "description": "the owner of the Condition.", "name": "account", "type": "string" }, { - "description": "Name of CNI Configuration associated with the cluster", - "name": "cniconfigname", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "ID of CNI Configuration associated with the cluster", - "name": "cniconfigurationid", + "description": "zone id of counter", + "name": "zoneid", "type": "string" }, { - "description": "the project name of the Kubernetes cluster", - "name": "project", + "description": "path of the domain to which the Condition owner belongs", + "name": "domainpath", "type": "string" }, + {} + ] + }, + { + "description": "Lists projects and provides detailed information for listed projects", + "isasync": false, + "name": "listProjects", + "params": [ { - "description": "the ID of the service offering of the worker nodes on the Kubernetes cluster", - "name": "workerofferingid", + "description": "list projects by state", + "length": 255, + "name": "state", + "required": false, "type": "string" }, { - "description": "URL end point for the Kubernetes cluster dashboard UI", - "name": "consoleendpoint", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "list projects by name", + "length": 255, + "name": "name", + "required": false, + "type": "string" + }, + { + "description": "list projects by display text", + "length": 255, + "name": "displaytext", + "required": false, + "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": "List projects by username", + "length": 255, + "name": "username", + "required": false, + "type": "string" + }, + { + "description": "flag to display the resource icon for projects", + "length": 255, + "name": "showicon", + "required": false, "type": "boolean" }, { - "description": "the list of virtualmachine associated with this Kubernetes cluster", - "name": "virtualmachines", + "description": "List projects by tags (key/value pairs)", + "length": 255, + "name": "tags", + "required": false, + "type": "map" + }, + { + "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": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "comma separated list of project details requested, value can be a list of [ all, resource, min]", + "length": 255, + "name": "details", + "required": false, "type": "list" }, { - "description": "the name of the network of the Kubernetes cluster", - "name": "associatednetworkname", + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "the name of the Kubernetes cluster", - "name": "name", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "length": 255, + "name": "listall", + "required": false, + "type": "boolean" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "list projects by project ID", + "length": 255, + "name": "id", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "uuid" + } + ], + "related": "listProjectAccounts,activateProject,createProject,suspendProject,updateProject", + "response": [ + {}, + { + "description": "the total primary storage space (in GiB) the project can own", + "name": "primarystoragelimit", "type": "string" }, { - "description": "the project id of the Kubernetes cluster", - "name": "projectid", + "description": "the total secondary storage space (in GiB) owned by project", + "name": "secondarystoragetotal", + "type": "float" + }, + { + "description": "the total object storage space (in GiB) the project can own", + "name": "objectstoragelimit", "type": "string" }, { - "description": "the name of the service offering of the worker nodes on the Kubernetes cluster", - "name": "workerofferingname", + "description": "the total number of templates which can be created by this project", + "name": "templatelimit", + "type": "string" + }, + { + "description": "the total number of backups available to this project", + "name": "backupavailable", + "type": "string" + }, + { + "description": "the total number of networks owned by project", + "name": "networktotal", + "type": "long" + }, + { + "description": "the total number of cpu cores owned by project", + "name": "cputotal", + "type": "long" + }, + { + "description": "the project account name of the project", + "name": "projectaccountname", + "type": "string" + }, + { + "description": "the total number of buckets available to this project", + "name": "bucketavailable", + "type": "string" + }, + { + "description": "the total volume available for this project", + "name": "volumeavailable", + "type": "string" + }, + { + "description": "the total number of public ip addresses allocated for this project", + "name": "iptotal", + "type": "long" + }, + { + "description": "the total number of backups which can be stored by this project", + "name": "backuplimit", + "type": "string" + }, + { + "description": "the total number of gpus the project can own", + "name": "gpulimit", + "type": "string" + }, + { + "description": "the total number of virtual machines stopped for this project", + "name": "vmstopped", + "type": "integer" + }, + { + "description": "the total number of networks available to be created for this project", + "name": "networkavailable", "type": "string" }, { - "description": "the ID of the service offering of the control nodes on the Kubernetes cluster", - "name": "controlofferingid", + "description": "the displaytext of the project", + "name": "displaytext", + "type": "string" + }, + { + "description": "the total primary storage space (in GiB) owned by project", + "name": "primarystoragetotal", + "type": "long" + }, + { + "description": "the total number of snapshots stored by this project", + "name": "snapshottotal", + "type": "long" + }, + { + "description": "the total number of virtual machines deployed by this project", + "name": "vmtotal", + "type": "long" + }, + { + "description": "the total backup storage space (in GiB) the project can own", + "name": "backupstoragelimit", + "type": "string" + }, + { + "description": "the total backup storage space (in GiB) owned by the project", + "name": "backupstoragetotal", + "type": "long" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the state of the project", + "name": "state", + "type": "string" + }, + { + "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", + "type": "string" + }, + { + "description": "the total number of buckets stored by this project", + "name": "buckettotal", + "type": "long" + }, + { + "description": "the date this project was created", + "name": "created", + "type": "date" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the total number of virtual machines running for this project", + "name": "vmrunning", + "type": "integer" + }, + { + "description": "the list of resource tags associated with vm", + "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", + "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 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": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the total number of public ip addresses available for this project to acquire", + "name": "ipavailable", "type": "string" }, { - "description": "the type of the cluster", - "name": "clustertype", - "type": "clustertype" - }, - { - "description": "Public IP Address of the cluster", - "name": "ipaddress", + "description": "the total number of vpcs the project can own", + "name": "vpclimit", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the ID of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionid", + "description": "the total secondary storage space (in GiB) the project can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "the name of the service offering of the etcd nodes on the Kubernetes cluster", - "name": "etcdofferingname", - "type": "string" + "description": "the total number of backups stored by this project", + "name": "backuptotal", + "type": "long" }, { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zonename", + "description": "the total number of public ip addresses this project can acquire", + "name": "iplimit", "type": "string" }, { - "description": "Minimum size of the cluster", - "name": "minsize", + "description": "the total number of vpcs owned by project", + "name": "vpctotal", "type": "long" }, { - "description": "the ID of the service offering of the Kubernetes cluster", - "name": "serviceofferingid", - "type": "string" + "description": "the total object storage space (in GiB) owned by the project", + "name": "objectstoragetotal", + "type": "long" }, { - "description": "Public IP Addresses of the etcd nodes", - "name": "etcdips", - "type": "map" + "description": "The tagged resource limit and count for the project", + "name": "taggedresources", + "type": "list" }, { - "description": "path of the domain to which the Kubernetes cluster belongs", - "name": "domainpath", + "description": "the total secondary storage space (in GiB) available to be used for this project", + "name": "secondarystorageavailable", "type": "string" }, + {}, { - "description": "the size (worker nodes count) of the Kubernetes cluster", - "name": "size", + "description": "the total number of gpus owned by project", + "name": "gputotal", "type": "long" }, { - "description": "the name of the service offering of the control nodes on the Kubernetes cluster", - "name": "controlofferingname", - "type": "string" + "description": "the account name of the project's owners", + "name": "owner", + "type": "list" }, { - "description": "the ID of the network of the Kubernetes cluster", - "name": "networkid", + "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": "the total primary storage space (in GiB) available to be used for this project", + "name": "primarystorageavailable", "type": "string" }, { - "description": "the id of the Kubernetes cluster", - "name": "id", - "type": "string" + "description": "the total volume being used by this project", + "name": "volumetotal", + "type": "long" }, { - "description": "the control nodes count for the Kubernetes cluster", - "name": "controlnodes", + "description": "the total memory (in MB) owned by project", + "name": "memorytotal", "type": "long" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total number of snapshots which can be stored by this project", + "name": "snapshotlimit", "type": "string" }, { - "description": "the description of the Kubernetes cluster", - "name": "description", + "description": "the domain name where the project belongs to", + "name": "domain", "type": "string" }, { - "description": "the state of the Kubernetes cluster", - "name": "state", + "description": "the total number of cpu cores the project can own", + "name": "cpulimit", "type": "string" }, { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zoneid", + "description": "the total memory (in MB) the project can own", + "name": "memorylimit", "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": "Whether autoscaling is enabled for the cluster", - "name": "autoscalingenabled", - "type": "boolean" - }, - { - "description": "Maximum size of the cluster", - "name": "maxsize", - "type": "long" - }, - { - "description": "the name of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionname", + "description": "the total number of buckets which can be stored by this project", + "name": "bucketlimit", "type": "string" }, { - "description": "Public IP Address ID of the cluster", - "name": "ipaddressid", + "description": "the total backup storage space (in GiB) available to the project", + "name": "backupstorageavailable", "type": "string" - } - ] - }, - { - "description": "Creates a condition for VM auto scaling", - "isasync": true, - "name": "createCondition", - "params": [ - { - "description": "ID of the Counter.", - "length": 255, - "name": "counterid", - "related": "createCounter,listCounters", - "required": true, - "type": "uuid" - }, - { - "description": "an optional project for condition", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", - "required": false, - "type": "uuid" }, { - "description": "the account of the condition. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "the total number of vpcs available to be created for this project", + "name": "vpcavailable", "type": "string" }, { - "description": "the domain ID of the account.", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", - "required": false, - "type": "uuid" - }, - { - "description": "Value for which the Counter will be evaluated with the Operator selected.", - "length": 255, - "name": "threshold", - "required": true, - "type": "long" - }, - { - "description": "Relational Operator to be used with threshold. Valid values are EQ, GT, LT, GE, LE.", - "length": 255, - "name": "relationaloperator", - "required": true, - "type": "string" - } - ], - "related": "listConditions", - "response": [ - { - "description": "the domain id of the Condition owner", - "name": "domainid", + "description": "the total memory (in MB) available to be created for this project", + "name": "memoryavailable", "type": "string" }, - {}, { - "description": "the id of the Condition", - "name": "id", + "description": "the domain id the project belongs to", + "name": "domainid", "type": "string" }, { - "description": "Threshold Value for the counter.", - "name": "threshold", - "type": "long" - }, - { - "description": "Details of the Counter.", - "name": "counter", - "type": "counterresponse" - }, - { - "description": "the project name of the Condition", - "name": "project", + "description": "the total volume which can be used by this project", + "name": "volumelimit", "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 Condition owner belongs", - "name": "domainpath", + "description": "the total number of templates available to be created by this project", + "name": "templateavailable", "type": "string" }, { - "description": "the Id of the Counter.", - "name": "counterid", + "description": "the total number of virtual machines that can be deployed by this project", + "name": "vmlimit", "type": "string" }, { - "description": "Relational Operator to be used with threshold.", - "name": "relationaloperator", + "description": "the total number of networks the project can own", + "name": "networklimit", "type": "string" }, { - "description": "the project id of the Condition.", - "name": "projectid", - "type": "string" + "description": "the total number of templates which have been created by this project", + "name": "templatetotal", + "type": "long" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total object storage space (in GiB) available to the project", + "name": "objectstorageavailable", "type": "string" }, { - "description": "zone id of counter", - "name": "zoneid", + "description": "the total number of snapshots available for this project", + "name": "snapshotavailable", "type": "string" }, { - "description": "the owner of the Condition.", - "name": "account", + "description": "the name of the project", + "name": "name", "type": "string" }, { - "description": "the Name of the Counter.", - "name": "countername", + "description": "the total number of cpu cores available to be created for this project", + "name": "cpuavailable", "type": "string" }, { - "description": "the domain name of the owner.", - "name": "domain", + "description": "the total number of virtual machines available for this project to acquire", + "name": "vmavailable", "type": "string" } - ] + ], + "since": "3.0.0" }, { - "description": "Lists projects and provides detailed information for listed projects", + "description": "Creates an account", "isasync": false, - "name": "listProjects", + "name": "createAccount", "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": "email", "length": 255, - "name": "listall", - "required": false, - "type": "boolean" + "name": "email", + "required": true, + "type": "string" }, { - "description": "list projects by state", + "description": "User UUID, required for adding account from external provisioning system", "length": 255, - "name": "state", + "name": "userid", "required": false, "type": "string" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", "length": 255, - "name": "isrecursive", + "name": "timezone", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "list projects by display text", + "description": "Account UUID, required for adding account from external provisioning system", "length": 255, - "name": "displaytext", + "name": "accountid", "required": false, "type": "string" }, { - "description": "List projects by tags (key/value pairs)", + "description": "Unique username.", "length": 255, - "name": "tags", - "required": false, - "type": "map" + "name": "username", + "required": true, + "type": "string" }, { - "description": "list projects by name", + "description": "Creates the user under the specified domain.", "length": 255, - "name": "name", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "List by keyword", + "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": "keyword", + "name": "account", "required": false, "type": "string" }, { - "description": "comma separated list of project details requested, value can be a list of [ all, resource, min]", + "description": "lastname", "length": 255, - "name": "details", - "required": false, - "type": "list" + "name": "lastname", + "required": true, + "type": "string" }, { - "description": "", + "description": "firstname", "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "name": "firstname", + "required": true, + "type": "string" }, { - "description": "List projects by username", + "description": "Type of the account. Specify 0 for user, 1 for root admin, and 2 for domain admin", "length": 255, - "name": "username", + "name": "accounttype", "required": false, - "type": "string" + "type": "integer" }, { - "description": "flag to display the resource icon for projects", + "description": "details for account used to store specific parameters", "length": 255, - "name": "showicon", + "name": "accountdetails", "required": false, - "type": "boolean" + "type": "map" }, { - "description": "list only resources belonging to the domain specified", + "description": "Creates the account under the specified role.", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "name": "roleid", + "related": "createRole,importRole,listRoles,updateRole", "required": false, "type": "uuid" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "Network domain for the account's networks", "length": 255, - "name": "account", + "name": "networkdomain", "required": false, "type": "string" }, { - "description": "list projects by project ID", - "length": 255, - "name": "id", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", - "required": false, - "type": "uuid" - }, - { - "description": "", + "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": "page", - "required": false, - "type": "integer" + "name": "password", + "required": true, + "type": "string" } ], - "related": "listProjectAccounts,activateProject,createProject,suspendProject,updateProject", + "related": "disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", "response": [ { - "description": "the total number of virtual machines deployed by this project", - "name": "vmtotal", + "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 state of the project", - "name": "state", + "description": "account type (admin, domain-admin, user)", + "name": "accounttype", + "type": "integer" + }, + { + "description": "path of the Domain the account belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the total number of vpcs the project can own", - "name": "vpclimit", + "description": "the total number of buckets available to this account", + "name": "bucketavailable", "type": "string" }, { - "description": "the total number of networks the project can own", + "description": "the total object storage space (in GiB) owned by the account", + "name": "objectstoragetotal", + "type": "long" + }, + { + "description": "the total number of networks the account can own", "name": "networklimit", "type": "string" }, { - "description": "the total memory (in MB) owned by project", - "name": "memorytotal", + "description": "the total number of snapshots available for this account", + "name": "snapshotavailable", + "type": "string" + }, + { + "description": "the total number of cpu cores available to be created for this account", + "name": "cpuavailable", + "type": "string" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the total secondary storage space (in GiB) available to be used for this account", + "name": "secondarystorageavailable", + "type": "string" + }, + { + "description": "the total number of networks owned by account", + "name": "networktotal", "type": "long" }, - {}, { - "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 account", + "name": "iptotal", "type": "long" }, { - "description": "the list of resource tags associated with vm", - "name": "tags", + "description": "the list of users associated with account", + "name": "user", "response": [ { - "description": "tag key name", - "name": "key", + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the domain ID of the user", + "name": "domainid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the domain name of the user", + "name": "domain", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "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", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the user lastname", + "name": "lastname", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the account name of the user", + "name": "account", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the type of the role", + "name": "roletype", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the user firstname", + "name": "firstname", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "true if user has two factor authentication is mandated", + "name": "is2famandated", + "type": "boolean" + }, + { + "description": "true if user has two factor authentication enabled", + "name": "is2faenabled", + "type": "boolean" + }, + { + "description": "the date and time the user account was created", + "name": "created", + "type": "date" + }, + { + "description": "the user email address", + "name": "email", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the secret key of the user", + "name": "secretkey", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the user name", + "name": "username", + "type": "string" + }, + { + "description": "the timezone user was created in", + "name": "timezone", + "type": "string" + }, + { + "description": "the user ID", + "name": "id", + "type": "string" + }, + { + "description": "the account ID of the user", + "name": "accountid", + "type": "string" + }, + { + "description": "the name of the role", + "name": "rolename", + "type": "string" + }, + { + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" + }, + { + "description": "the api key of the user", + "name": "apikey", + "type": "string" + }, + { + "description": "the ID of the role", + "name": "roleid", "type": "string" + }, + { + "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", + "name": "apikeyaccess", + "type": "apikeyaccess" } ], "type": "list" }, { - "description": "the total number of cpu cores owned by project", - "name": "cputotal", - "type": "long" - }, - { - "description": "the total number of public ip addresses this project can acquire", - "name": "iplimit", - "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", + "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 project", - "name": "templatetotal", - "type": "long" - }, - { - "description": "the total primary storage space (in GiB) owned by project", + "description": "the total primary storage space (in GiB) owned by account", "name": "primarystoragetotal", "type": "long" }, { - "description": "the total number of virtual machines stopped for this project", - "name": "vmstopped", - "type": "integer" + "description": "the date when this account was created", + "name": "created", + "type": "date" }, { - "description": "the total secondary storage space (in GiB) the project can own", - "name": "secondarystoragelimit", - "type": "string" + "description": "the total number of cpu cores owned by account", + "name": "cputotal", + "type": "long" }, { - "description": "the name of the project", - "name": "name", + "description": "the total number of networks available to be created for this account", + "name": "networkavailable", "type": "string" }, { - "description": "the total object storage space (in GiB) available to the project", - "name": "objectstorageavailable", + "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 total number of backups which can be stored by this project", - "name": "backuplimit", + "description": "the total backup storage space (in GiB) the account can own", + "name": "backupstoragelimit", "type": "string" }, { - "description": "the total backup storage space (in GiB) available to the project", - "name": "backupstorageavailable", + "description": "the total number of cpu cores the account can own", + "name": "cpulimit", "type": "string" }, { - "description": "the total number of gpus the project can own", - "name": "gpulimit", - "type": "string" + "description": "the total secondary storage space (in GiB) owned by account", + "name": "secondarystoragetotal", + "type": "float" }, { - "description": "the total memory (in MB) available to be created for this project", - "name": "memoryavailable", - "type": "string" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "the total number of buckets stored by this project", - "name": "buckettotal", + "description": "the total number of backups stored by this account", + "name": "backuptotal", "type": "long" }, { - "description": "the total number of virtual machines that can be deployed by this project", - "name": "vmlimit", + "description": "id of the Domain the account belongs to", + "name": "domainid", "type": "string" }, { - "description": "the total secondary storage space (in GiB) available to be used for this project", - "name": "secondarystorageavailable", + "description": "the total number of gpus available to be created for this account", + "name": "gpuavailable", "type": "string" }, { - "description": "the total backup storage space (in GiB) owned by the project", - "name": "backupstoragetotal", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", "type": "long" }, { - "description": "the total number of cpu cores the project can own", - "name": "cpulimit", + "description": "the total secondary storage space (in GiB) the account can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "the total primary storage space (in GiB) available to be used for this project", - "name": "primarystorageavailable", + "description": "the total object storage space (in GiB) available to the account", + "name": "objectstorageavailable", "type": "string" }, { - "description": "the displaytext of the project", - "name": "displaytext", + "description": "the total number of snapshots which can be stored by this account", + "name": "snapshotlimit", "type": "string" }, { - "description": "the id of the project", - "name": "id", - "type": "string" + "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", + "name": "apikeyaccess", + "type": "apikeyaccess" }, { - "description": "the total number of public ip addresses available for this project to acquire", - "name": "ipavailable", + "description": "the total number of backups which can be stored by this account", + "name": "backuplimit", "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 account", + "name": "bucketlimit", + "type": "string" }, { - "description": "the total backup storage space (in GiB) the project can own", - "name": "backupstoragelimit", + "description": "the total number of projects available for administration by this account", + "name": "projectavailable", "type": "string" }, { - "description": "the project account name of the project", - "name": "projectaccountname", + "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", + "name": "roletype", "type": "string" }, { - "description": "the total number of virtual machines available for this project to acquire", - "name": "vmavailable", - "type": "string" + "description": "The tagged resource limit and count for the account", + "name": "taggedresources", + "type": "list" }, { - "description": "the total volume available for this project", - "name": "volumeavailable", + "description": "the total primary storage space (in GiB) available to be used for this account", + "name": "primarystorageavailable", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "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 project", - "name": "vpcavailable", + "description": "the total number of backups available to this account", + "name": "backupavailable", "type": "string" }, { - "description": "the total number of gpus owned by project", - "name": "gputotal", - "type": "long" + "description": "the total number of gpus the account can own", + "name": "gpulimit", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "true if the account requires cleanup", + "name": "iscleanuprequired", + "type": "boolean" }, { - "description": "the total number of snapshots available for this project", - "name": "snapshotavailable", + "description": "the state of the account", + "name": "state", "type": "string" }, { - "description": "the total number of buckets which can be stored by this project", - "name": "bucketlimit", + "description": "the name of the role", + "name": "rolename", "type": "string" }, { - "description": "the total primary storage space (in GiB) the project can own", - "name": "primarystoragelimit", - "type": "string" + "description": "details for the account", + "name": "accountdetails", + "type": "map" }, { - "description": "the total memory (in MB) the project can own", - "name": "memorylimit", + "description": "the total number of projects the account can own", + "name": "projectlimit", "type": "string" }, + {}, { - "description": "the total volume being used by this project", - "name": "volumetotal", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the total number of snapshots stored by this account", + "name": "snapshottotal", "type": "long" }, { - "description": "the total volume which can be used by this project", - "name": "volumelimit", + "description": "the total number of vpcs the account can own", + "name": "vpclimit", "type": "string" }, { - "description": "the total number of cpu cores available to be created for this project", - "name": "cpuavailable", + "description": "the total number of vpcs available to be created for this account", + "name": "vpcavailable", "type": "string" }, { - "description": "the domain name where the project belongs to", - "name": "domain", - "type": "string" + "description": "the total number of virtual machines deployed by this account", + "name": "vmtotal", + "type": "long" }, { - "description": "the total number of networks owned by project", - "name": "networktotal", + "description": "the total number of vpcs owned by account", + "name": "vpctotal", "type": "long" }, { - "description": "the total number of networks available to be created for this project", - "name": "networkavailable", + "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 project", - "name": "gpuavailable", - "type": "string" + "description": "the total number of templates which have been created by this account", + "name": "templatetotal", + "type": "long" }, { - "description": "the total number of virtual machines running for this project", - "name": "vmrunning", - "type": "integer" + "description": "the total memory (in MB) available to be created for this account", + "name": "memoryavailable", + "type": "string" }, { - "description": "the total number of vpcs owned by project", - "name": "vpctotal", - "type": "long" + "description": "true if account is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the total number of buckets available to this project", - "name": "bucketavailable", + "description": "the id of the account", + "name": "id", "type": "string" }, { - "description": "the total number of backups available to this project", - "name": "backupavailable", - "type": "string" + "description": "the total number of projects being administrated by this account", + "name": "projecttotal", + "type": "long" }, { - "description": "the date this project was created", - "name": "created", - "type": "date" + "description": "the network domain", + "name": "networkdomain", + "type": "string" }, + {}, { - "description": "The tagged resource limit and count for the project", - "name": "taggedresources", + "description": "the list of acl groups that account belongs to", + "name": "groups", "type": "list" }, { - "description": "the total number of templates which can be created by this project", - "name": "templatelimit", + "description": "the total memory (in MB) the account can own", + "name": "memorylimit", "type": "string" }, { - "description": "the total number of snapshots which can be stored by this project", - "name": "snapshotlimit", + "description": "the total volume which can be used by this account", + "name": "volumelimit", "type": "string" }, { - "description": "the total object storage space (in GiB) the project can own", - "name": "objectstoragelimit", + "description": "the total volume available for this account", + "name": "volumeavailable", "type": "string" }, - {}, - { - "description": "the account name of the project's owners", - "name": "owner", - "type": "list" - }, { - "description": "the domain id the project belongs to", - "name": "domainid", + "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 total number of virtual machines running for this account", + "name": "vmrunning", + "type": "integer" }, { - "description": "the total secondary storage space (in GiB) owned by project", - "name": "secondarystoragetotal", - "type": "float" - } - ], - "since": "3.0.0" - }, - { - "description": "Creates an account", - "isasync": false, - "name": "createAccount", - "params": [ + "description": "the total number of gpus owned by account", + "name": "gputotal", + "type": "long" + }, { - "description": "email", - "length": 255, - "name": "email", - "required": true, + "description": "the total number of public ip addresses this account can acquire", + "name": "iplimit", "type": "string" }, { - "description": "firstname", - "length": 255, - "name": "firstname", - "required": true, + "description": "the total number of virtual machines that can be deployed by this account", + "name": "vmlimit", "type": "string" }, { - "description": "Creates the user under the specified domain.", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", - "required": false, - "type": "uuid" + "description": "the total memory (in MB) owned by account", + "name": "memorytotal", + "type": "long" }, { - "description": "Creates the account under the specified role.", - "length": 255, + "description": "the ID of the role", "name": "roleid", - "related": "createRole,importRole,listRoles,updateRole", - "required": false, - "type": "uuid" + "type": "string" }, { - "description": "lastname", - "length": 255, - "name": "lastname", - "required": true, - "type": "string" + "description": "the total backup storage space (in GiB) owned by the account", + "name": "backupstoragetotal", + "type": "long" }, { - "description": "Clear text password (Default hashed to SHA256SALT). If you wish to use any other hashing algorithm, you would need to write a custom authentication adapter See Docs section.", - "length": 255, - "name": "password", - "required": true, + "description": "the name of the account", + "name": "name", "type": "string" }, { - "description": "Name of the account to be created. The user will be added to this newly created account. If no account is specified, the username will be used as the account name.", - "length": 255, - "name": "account", - "required": false, + "description": "name of the Domain the account belongs to", + "name": "domain", "type": "string" }, { - "description": "Account UUID, required for adding account from external provisioning system", - "length": 255, - "name": "accountid", - "required": false, + "description": "the default zone of the account", + "name": "defaultzoneid", "type": "string" }, { - "description": "details for account used to store specific parameters", - "length": 255, - "name": "accountdetails", - "required": false, - "type": "map" + "description": "the total volume being used by this account", + "name": "volumetotal", + "type": "long" }, { - "description": "User UUID, required for adding account from external provisioning system", - "length": 255, - "name": "userid", - "required": false, + "description": "the total number of virtual machines available for this account to acquire", + "name": "vmavailable", "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": "the total object storage space (in GiB) the account can own", + "name": "objectstoragelimit", "type": "string" }, { - "description": "Unique username.", + "description": "the total number of templates available to be created by this account", + "name": "templateavailable", + "type": "string" + } + ] + }, + { + "description": "Revert VM from a vmsnapshot.", + "isasync": true, + "name": "revertToVMSnapshot", + "params": [ + { + "description": "The ID of the vm snapshot", "length": 255, - "name": "username", + "name": "vmsnapshotid", + "related": "listVMSnapshot,createVMSnapshot", "required": true, + "type": "uuid" + } + ], + "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,createVMFromBackup,createVMFromBackup,assignVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", + "response": [ + { + "description": "the VM's primary IP address", + "name": "ipaddress", "type": "string" }, { - "description": "Network domain for the account's networks", - "length": 255, - "name": "networkdomain", - "required": false, - "type": "string" + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "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": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the total number of gpus the account can own", - "name": "gpulimit", - "type": "string" + "description": "the video RAM size in MB", + "name": "videoram", + "type": "long" }, { - "description": "the list of acl groups that account belongs to", - "name": "groups", - "type": "list" + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", + "type": "string" }, { - "description": "path of the Domain the account 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 list of users associated with account", - "name": "user", + "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": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" }, { - "description": "the api key of the user", - "name": "apikey", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "the user ID", - "name": "id", + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the domain ID of the user", - "name": "domainid", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "the secret key of the user", - "name": "secretkey", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "true if user has two factor authentication enabled", - "name": "is2faenabled", - "type": "boolean" + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" }, { - "description": "true if user has two factor authentication is mandated", - "name": "is2famandated", - "type": "boolean" + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "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 name of the role", - "name": "rolename", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" + "description": "the type of the nic", + "name": "type", + "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 ip address of the nic", + "name": "ipaddress", + "type": "string" }, { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { - "description": "the timezone user was created in", - "name": "timezone", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the account name of the user", - "name": "account", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "the user name", - "name": "username", + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the user state", - "name": "state", - "type": "string" + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" }, { - "description": "the domain name of the user", - "name": "domain", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "the user firstname", - "name": "firstname", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the type of the role", - "name": "roletype", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "the account ID of the user", - "name": "accountid", - "type": "string" + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" }, { - "description": "the user email address", - "name": "email", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", + "description": "true if nic is default, false otherwise", + "name": "isdefault", "type": "boolean" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "the user lastname", - "name": "lastname", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "the ID of the nic", + "name": "id", "type": "string" } ], - "type": "list" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the total number of buckets available to this account", - "name": "bucketavailable", - "type": "string" - }, - { - "description": "account type (admin, domain-admin, user)", - "name": "accounttype", - "type": "integer" - }, - { - "description": "the total number of templates available to be created by this account", - "name": "templateavailable", - "type": "string" - }, - { - "description": "the total number of projects available for administration by this account", - "name": "projectavailable", - "type": "string" + "type": "set" }, { - "description": "the state of the account", - "name": "state", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "the total object storage space (in GiB) owned by the account", - "name": "objectstoragetotal", - "type": "long" - }, - { - "description": "the total object storage space (in GiB) available to the account", - "name": "objectstorageavailable", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "the total memory (in MB) available to be created for this account", - "name": "memoryavailable", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "name of the Domain the account belongs to", - "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 total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "the total number of projects being administrated by this account", - "name": "projecttotal", - "type": "long" - }, - { - "description": "the total volume being used by this account", - "name": "volumetotal", + "description": "device ID of the root volume", + "name": "rootdeviceid", "type": "long" }, { - "description": "details for the account", - "name": "accountdetails", - "type": "map" - }, - { - "description": "the total memory (in MB) the account can own", - "name": "memorylimit", - "type": "string" - }, - { - "description": "the total number of gpus available to be created for this account", - "name": "gpuavailable", - "type": "string" - }, - { - "description": "the ID of the role", - "name": "roleid", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "the total number of virtual machines stopped for this account", - "name": "vmstopped", - "type": "integer" - }, - { - "description": "id of the Domain the account belongs to", - "name": "domainid", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the total primary storage space (in GiB) available to be used for this account", - "name": "primarystorageavailable", + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", "type": "string" }, { - "description": "the total number of vpcs the account can own", - "name": "vpclimit", + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", "type": "string" }, + {}, { - "description": "the total backup storage space (in GiB) owned by the account", - "name": "backupstoragetotal", + "description": "the memory used by the VM in KiB", + "name": "memorykbs", "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", - "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 total number of public ip addresses this account can acquire", - "name": "iplimit", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", - "name": "apikeyaccess", - "type": "apikeyaccess" - }, - { - "description": "the total number of backups available to this account", - "name": "backupavailable", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "true if the account requires cleanup", - "name": "iscleanuprequired", - "type": "boolean" - }, - { - "description": "true if account is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the total number of virtual machines deployed by this account", - "name": "vmtotal", + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", "type": "long" }, { - "description": "the total number of virtual machines available for this account to acquire", - "name": "vmavailable", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the total number of buckets which can be stored by this account", - "name": "bucketlimit", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { - "description": "The tagged resource limit and count for the account", - "name": "taggedresources", - "type": "list" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "the total backup storage space (in GiB) available to the account", - "name": "backupstorageavailable", - "type": "string" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "description": "the total number of networks available to be created for this account", - "name": "networkavailable", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "the total number of vpcs owned by account", - "name": "vpctotal", - "type": "long" - }, - {}, - { - "description": "the total secondary storage space (in GiB) the account can own", - "name": "secondarystoragelimit", + "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 templates which can be created by this account", - "name": "templatelimit", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "the total number of backups stored by this account", - "name": "backuptotal", - "type": "long" - }, - { - "description": "the total number of cpu cores owned by account", - "name": "cputotal", - "type": "long" - }, - { - "description": "the total number of networks owned by account", - "name": "networktotal", - "type": "long" - }, - { - "description": "the default zone of the account", - "name": "defaultzoneid", + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", "type": "string" }, { - "description": "the name of the account", - "name": "name", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "the total number of virtual machines running for this account", - "name": "vmrunning", - "type": "integer" - }, - { - "description": "the name of the role", - "name": "rolename", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the total number of snapshots stored by this account", - "name": "snapshottotal", - "type": "long" - }, - { - "description": "the total number of public ip addresses allocated for this account", - "name": "iptotal", - "type": "long" - }, - { - "description": "the total number of buckets stored by this account", - "name": "buckettotal", + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", "type": "long" }, { - "description": "the total primary storage space (in GiB) the account can own", - "name": "primarystoragelimit", - "type": "string" - }, - { - "description": "the total number of public ip addresses available for this account to acquire", - "name": "ipavailable", + "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 secondary storage space (in GiB) owned by account", - "name": "secondarystoragetotal", - "type": "float" + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", "type": "string" }, { - "description": "the total number of networks the account can own", - "name": "networklimit", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "the total number of gpus owned by account", - "name": "gputotal", - "type": "long" - }, - { - "description": "the total primary storage space (in GiB) owned by account", - "name": "primarystoragetotal", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "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", - "type": "string" - }, - { - "description": "the total number of projects the account can own", - "name": "projectlimit", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { @@ -46165,296 +46812,194 @@ "type": "long" }, { - "description": "the total number of cpu cores the account can own", - "name": "cpulimit", - "type": "string" - }, - { - "description": "the total number of virtual machines that can be deployed by this account", - "name": "vmlimit", - "type": "string" - }, - { - "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", - "name": "roletype", - "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 total volume which can be used by this account", - "name": "volumelimit", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "the total volume available for this account", - "name": "volumeavailable", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "the total number of templates which have been created by this account", - "name": "templatetotal", - "type": "long" - }, - { - "description": "the total memory (in MB) owned by account", - "name": "memorytotal", - "type": "long" - }, - { - "description": "the id of the account", - "name": "id", + "description": "CPU arch of the VM", + "name": "arch", "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": "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", - "type": "boolean" - }, - { - "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" }, { - "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": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "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": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", - "type": "string" - }, - { - "description": "the pool type of the virtual machine", - "name": "pooltype", - "type": "string" + "description": "Instance lease duration in days", + "name": "leaseduration", + "type": "integer" }, - {}, { "description": "list of security groups associated with the virtual machine", "name": "securitygroup", "response": [ { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", + "description": "the list of resource tags associated with the rule", + "name": "tags", "response": [ { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" + "description": "id of the resource", + "name": "resourceid", + "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": "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": "tag key name", + "name": "key", + "type": "string" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "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": "account owning the security group rule", - "name": "account", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" }, { - "description": "the 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 account associated with the tag", + "name": "account", + "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" + }, + { + "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 domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "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", + "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", + "description": "the starting IP of the security group rule", + "name": "startport", "type": "integer" }, { - "description": "security group name", - "name": "securitygroupname", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" }, { "description": "the type of the ICMP message response", @@ -46467,47 +47012,37 @@ "type": "string" }, { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", + "description": "the code for the ICMP message response", + "name": "icmpcode", "type": "integer" }, - { - "description": "the 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 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", + "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": "tag key name", - "name": "key", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -46516,605 +47051,343 @@ "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", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" - } - ], - "type": "set" - } - ], - "type": "set" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the 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 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 project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name of the group", - "name": "project", - "type": "string" - }, - { - "description": "the ID of the security group", - "name": "id", - "type": "string" - }, - { - "description": "the name of the security group", - "name": "name", - "type": "string" - }, - { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the account owning the security group", - "name": "account", - "type": "string" - }, - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - } - ], - "type": "set" - }, - { - "description": "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": "OS name of the vm", - "name": "osdisplayname", - "type": "string" - }, - { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "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 count of GPUs on the virtual machine", - "name": "gpucount", - "type": "integer" - }, - { - "description": "the ID of the host for the virtual machine", - "name": "hostid", - "type": "string" - }, - { - "description": "the maximum Y resolution", - "name": "maxresolutiony", - "type": "long" - }, - { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" - }, - { - "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 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 write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "CPU arch of the VM", - "name": "arch", - "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": "tag key name", + "name": "key", + "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" + } + ], + "type": "set" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "the project name of the group", + "name": "project", "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 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": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the 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 list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "set" + } + ], + "type": "set" }, { - "description": "the ID of the nic", + "description": "the ID of the security group", "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" + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" } ], "type": "set" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" - }, - { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "the name of the vgpu profile to which service offering is linked", - "name": "vgpuprofilename", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, - {}, - { - "description": "the maximum X resolution", - "name": "maxresolutionx", - "type": "long" - }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" - }, - { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" - }, - { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "the ID of the gpu card to which service offering is linked", - "name": "gpucardid", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", + "description": "the list of resource tags associated", + "name": "tags", "response": [ { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "description": "the description of the affinity group", - "name": "description", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the project ID of the affinity group", + "description": "the project id the tag belongs to", "name": "projectid", "type": "string" }, { - "description": "the account owning the affinity group", - "name": "account", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the ID of the affinity group", - "name": "id", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", - "type": "list" + "description": "resource type", + "name": "resourcetype", + "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", + "description": "tag key name", + "name": "key", "type": "string" } ], "type": "set" }, - { - "description": "the ID of the vgpu profile to which service offering is linked", - "name": "vgpuprofileid", - "type": "string" - }, { "description": "Guest vm Boot Mode", "name": "bootmode", "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" - }, - { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "description": "the name of userdata used for the VM", + "name": "userdataname", + "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": "OS type id of the vm", - "name": "ostypeid", - "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 format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", + "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, - {}, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "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": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", "type": "boolean" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", - "type": "string" + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { - "description": "Instance lease expiry action", - "name": "leaseexpiryaction", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "State of the Service from LB rule", + "name": "servicestate", "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": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { @@ -47123,201 +47396,137 @@ "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, + { + "description": "User VM type", + "name": "vmtype", "type": "string" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", + "type": "string" }, + {}, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "the maximum Y resolution", + "name": "maxresolutiony", + "type": "long" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "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": "Instance lease duration in days", - "name": "leaseduration", - "type": "integer" + "description": "Base64 string containing the user data", + "name": "userdata", + "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": "tag value", - "name": "value", - "type": "string" + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + }, + { + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the type of the affinity group", + "name": "type", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the name of the affinity group", + "name": "name", "type": "string" } ], "type": "set" }, { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" - }, - { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" - }, - { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "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 name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the maximum number of display heads", - "name": "maxheads", - "type": "long" - }, - { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", + "description": "the maximum X resolution", + "name": "maxresolutionx", "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", - "type": "string" - }, - { - "description": "device type of the root volume", - "name": "rootdevicetype", - "type": "string" - }, - { - "description": "User VM type", - "name": "vmtype", - "type": "string" - }, - { - "description": "the name of the gpu card to which service offering is linked", - "name": "gpucardname", - "type": "string" - }, - { - "description": "the project name of the vm", - "name": "project", - "type": "string" - }, - { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", - "type": "string" - }, - { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", - "type": "string" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { "description": "the ID of the backup offering of the virtual machine", @@ -47325,13 +47534,18 @@ "type": "string" }, { - "description": "the video RAM size in MB", - "name": "videoram", + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", "type": "long" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { @@ -47340,74 +47554,55 @@ "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", + "description": "the maximum number of display heads", + "name": "maxheads", "type": "long" }, + {}, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", "type": "string" }, { - "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 read-only Vm details as comma separated string.", - "name": "readonlydetails", + "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": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the id of userdata used for the VM", + "name": "userdataid", "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 hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "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": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { "description": "the read (IO) of disk on the VM", "name": "diskioread", "type": "long" - }, - { - "description": "the name of the host for the virtual machine", - "name": "hostname", - "type": "string" - }, - { - "description": "the name of userdata used for the VM", - "name": "userdataname", - "type": "string" - }, - { - "description": "the type of the template for the virtual machine", - "name": "templatetype", - "type": "string" } ], "since": "4.2.0" @@ -47427,10 +47622,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" }, {}, { @@ -47438,16 +47634,15 @@ "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.4.0" @@ -47465,11 +47660,12 @@ "type": "integer" }, { - "description": "Tungsten-Fabric service group protocol", + "description": "the ID of zone", "length": 255, - "name": "protocol", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": true, - "type": "string" + "type": "uuid" }, { "description": "Tungsten-Fabric service group name", @@ -47479,69 +47675,68 @@ "type": "string" }, { - "description": "the ID of zone", + "description": "Tungsten-Fabric service group start port", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "startport", "required": true, - "type": "uuid" + "type": "integer" }, { - "description": "Tungsten-Fabric service group start port", + "description": "Tungsten-Fabric service group protocol", "length": 255, - "name": "startport", + "name": "protocol", "required": true, - "type": "integer" + "type": "string" } ], "related": "", "response": [ - { - "description": "Tungsten-Fabric service group uuid", - "name": "uuid", - "type": "string" - }, - { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "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": "Tungsten-Fabric service group end port", "name": "endport", "type": "int" }, - {}, { - "description": "Tungsten-Fabric service group protocol", - "name": "protocol", + "description": "Tungsten-Fabric service group uuid", + "name": "uuid", "type": "string" }, - {}, { "description": "Tungsten-Fabric service group 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" + }, { "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 service group protocol", + "name": "protocol", "type": "string" + }, + { + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" } ] }, @@ -47560,28 +47755,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 UUID of the latest async 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.20.0" }, @@ -47591,25 +47786,33 @@ "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.", + "description": "Image store UUID", "length": 255, - "name": "checksum", + "name": "imagestoreuuid", "required": false, "type": "string" }, { - "description": "an optional account name. Must be used with domainId.", + "description": "true if the ISO or its derivatives are extractable; default is false", "length": 255, - "name": "account", + "name": "isextractable", + "required": false, + "type": "boolean" + }, + { + "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" }, { - "description": "true if ISO should bypass Secondary Storage and be downloaded to Primary Storage on deployment", + "description": "the CPU arch of the ISO. Valid options are: x86_64, aarch64", "length": 255, - "name": "directdownload", + "name": "arch", "required": false, - "type": "boolean" + "since": "4.20", + "type": "string" }, { "description": "Register ISO for the project", @@ -47627,39 +47830,23 @@ "type": "string" }, { - "description": "the ID of the OS type that best represents the OS of this ISO. If the ISO is bootable this parameter needs to be passed", + "description": "true if ISO should bypass Secondary Storage and be downloaded to Primary Storage on deployment", "length": 255, - "name": "ostypeid", - "related": "addGuestOs", + "name": "directdownload", "required": false, - "type": "uuid" - }, - { - "description": "the name of the ISO", - "length": 255, - "name": "name", - "required": true, - "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" + "type": "boolean" }, { - "description": "true if password reset feature is supported; default is false", + "description": "true if ISO contains XS/VMWare tools inorder to support dynamic scaling of VM CPU/memory", "length": 255, - "name": "passwordenabled", + "name": "isdynamicallyscalable", "required": false, "type": "boolean" }, { - "description": "true if you want this ISO to be featured", + "description": "true if this ISO is bootable. If not passed explicitly its assumed to be true", "length": 255, - "name": "isfeatured", + "name": "bootable", "required": false, "type": "boolean" }, @@ -47671,47 +47858,40 @@ "type": "string" }, { - "description": "the CPU arch of the ISO. Valid options are: x86_64, aarch64", - "length": 255, - "name": "arch", - "required": false, - "since": "4.20", - "type": "string" - }, - { - "description": "Image store UUID", + "description": "true if you want this ISO to be featured", "length": 255, - "name": "imagestoreuuid", + "name": "isfeatured", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "true if the ISO or its derivatives are extractable; default is false", + "description": "true if password reset feature is supported; default is false", "length": 255, - "name": "isextractable", + "name": "passwordenabled", "required": false, "type": "boolean" }, { - "description": "true if this ISO is bootable. If not passed explicitly its assumed to be true", + "description": "true if you want to register the ISO to be publicly available to all users, false otherwise.", "length": 255, - "name": "bootable", + "name": "ispublic", "required": false, "type": "boolean" }, { - "description": "true if ISO contains XS/VMWare tools inorder to support dynamic scaling of VM CPU/memory", + "description": "an optional account name. Must be used with domainId.", "length": 255, - "name": "isdynamicallyscalable", + "name": "account", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "true if you want to register the ISO to be publicly available to all users, false otherwise.", + "description": "the ID of the zone you wish to register the ISO to.", "length": 255, - "name": "ispublic", - "required": false, - "type": "boolean" + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": true, + "type": "uuid" }, { "description": "an optional domainId. If the account parameter is used, domainId must also be used.", @@ -47720,70 +47900,110 @@ "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, "type": "uuid" + }, + { + "description": "the ID of the OS type that best represents the OS of this ISO. If the ISO is bootable this parameter needs to be passed", + "length": 255, + "name": "ostypeid", + "related": "addGuestOs", + "required": false, + "type": "uuid" + }, + { + "description": "the name of the ISO", + "length": 255, + "name": "name", + "required": true, + "type": "string" } ], - "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", "response": [ { - "description": "the status of the template", - "name": "status", - "type": "string" + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", + "type": "boolean" }, { - "description": "the URL which the template/iso is registered from", - "name": "url", + "description": "path of the Domain the template belongs to", + "name": "domainpath", "type": "string" }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", + "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", + "name": "deployasis", "type": "boolean" }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", - "type": "string" + "description": "the format of the template.", + "name": "format", + "type": "imageformat" }, { - "description": "path of the Domain the template belongs to", - "name": "domainpath", + "description": "the ID of the OS type for this template.", + "name": "ostypeid", "type": "string" }, + {}, { "description": "the ID of the secondary storage host for the template", "name": "hostid", "type": "string" }, { - "description": "The name of extension linked to this template", - "name": "extensionname", + "description": "the status of the template", + "name": "status", "type": "string" }, + { + "description": "the date this template was created", + "name": "created", + "type": "date" + }, + { + "description": "the size of the template", + "name": "size", + "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": "the account name to which the template belongs", "name": "account", "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": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", + "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": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", + "name": "userdataparams", "type": "string" }, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "the type of the template", + "name": "templatetype", + "type": "string" }, { "description": "the hypervisor on which the template runs", @@ -47791,8 +48011,13 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "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", "type": "string" }, { @@ -47801,87 +48026,108 @@ "type": "boolean" }, { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", - "type": "boolean" + "description": "the ID of the domain to which the template belongs", + "name": "domainid", + "type": "string" }, { - "description": "the tag of this template", - "name": "templatetag", + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", "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": "true if the template is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "the ID of the zone for this template", + "name": "zoneid", + "type": "string" }, { - "description": "the project name of the template", - "name": "project", + "description": "the physical size of the template", + "name": "physicalsize", + "type": "long" + }, + { + "description": "the name of the domain to which the template belongs", + "name": "domain", "type": "string" }, { - "description": "the project id of the template", - "name": "projectid", + "description": "The ID of extension linked to this template", + "name": "extensionid", "type": "string" }, { - "description": "the date this template was created", - "name": "created", - "type": "date" + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", + "type": "boolean" }, { - "description": "the ID of the zone for this template", - "name": "zoneid", - "type": "string" + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", + "type": "boolean" }, { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", + "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 userdata linked to this template", - "name": "userdataname", + "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 template display text", + "name": "displaytext", "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 template name", + "name": "name", + "type": "string" + }, + { + "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": "path of the Domain associated with the tag", - "name": "domainpath", + "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 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": "tag key name", - "name": "key", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -47890,13 +48136,13 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -47905,43 +48151,32 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", - "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" } ], "type": "set" }, { - "description": "the id of userdata linked to this template", - "name": "userdataid", - "type": "string" - }, - { - "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": "additional key/value details tied with template", - "name": "details", - "type": "map" + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", + "type": "boolean" }, { - "description": "the 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": "checksum of the template", @@ -47949,75 +48184,50 @@ "type": "string" }, { - "description": "the processor bit size", - "name": "bits", - "type": "int" - }, - { - "description": "the date this template was removed", - "name": "removed", - "type": "date" - }, - { - "description": "the template name", - "name": "name", - "type": "string" - }, - { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", - "type": "boolean" - }, - { - "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": "if root disk template, then ids of the datas disk templates this template owns", "name": "childtemplates", "type": "set" }, - {}, - { - "description": "the physical size of the template", - "name": "physicalsize", - "type": "long" - }, { - "description": "the name of the domain to which the template belongs", - "name": "domain", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "If true it indicates that the template can be used for CKS cluster deployments", - "name": "forcks", - "type": "boolean" + "description": "the id of userdata linked to this template", + "name": "userdataid", + "type": "string" }, { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", - "type": "boolean" + "description": "the account id to which the template belongs", + "name": "accountid", + "type": "string" }, { - "description": "The ID of extension linked to this template", - "name": "extensionid", + "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 template ID", + "name": "id", + "type": "string" }, { "description": "the name of the zone for this template", "name": "zonename", "type": "string" }, + {}, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the name of the OS type for this template.", + "name": "ostypename", + "type": "string" }, { "description": "the userdata override policy with the userdata provided while deploying VM", @@ -48025,58 +48235,43 @@ "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", + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", "type": "boolean" }, { - "description": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", - "type": "map" - }, - { - "description": "the name of the secondary storage host for the template", - "name": "hostname", - "type": "string" + "description": "the processor bit size", + "name": "bits", + "type": "int" }, { - "description": "the template display text", - "name": "displaytext", + "description": "CPU Arch of the template", + "name": "arch", "type": "string" }, { - "description": "the template ID", - "name": "id", - "type": "string" + "description": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" }, { - "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": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", "type": "boolean" }, { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" - }, - { - "description": "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 extension linked to this template", + "name": "extensionname", "type": "string" }, { - "description": "CPU Arch of the template", - "name": "arch", + "description": "the name of userdata linked to this template", + "name": "userdataname", "type": "string" } ] @@ -48086,6 +48281,13 @@ "isasync": false, "name": "listCiscoAsa1000vResources", "params": [ + { + "description": "Hostname or ip address of the Cisco ASA 1000v appliance.", + "length": 255, + "name": "hostname", + "required": false, + "type": "string" + }, { "description": "", "length": 255, @@ -48100,13 +48302,6 @@ "required": false, "type": "string" }, - { - "description": "Hostname or ip address of the Cisco ASA 1000v appliance.", - "length": 255, - "name": "hostname", - "required": false, - "type": "string" - }, { "description": "", "length": 255, @@ -48115,32 +48310,24 @@ "type": "integer" }, { - "description": "the Physical Network ID", + "description": "Cisco ASA 1000v resource ID", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", + "name": "resourceid", + "related": "addCiscoAsa1000vResource,listCiscoAsa1000vResources", "required": false, "type": "uuid" }, { - "description": "Cisco ASA 1000v resource ID", + "description": "the Physical Network ID", "length": 255, - "name": "resourceid", - "related": "addCiscoAsa1000vResource,listCiscoAsa1000vResources", + "name": "physicalnetworkid", + "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", "required": false, "type": "uuid" } ], "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", @@ -48149,7 +48336,15 @@ }, {}, {}, - {} + {}, + {}, + {}, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } ] }, { @@ -48167,27 +48362,27 @@ } ], "response": [ + {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ] }, @@ -48205,59 +48400,59 @@ "type": "uuid" }, { - "description": "upgrades all routers owned by the specified account", + "description": "upgrades router with the specified Id", "length": 255, - "name": "account", + "name": "id", + "related": "destroyRouter,listRouters,rebootRouter,stopRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "upgrades all routers within the specified cluster", + "description": "upgrades all routers owned by the specified account", "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "upgrades all routers owned by the specified domain", + "description": "upgrades all routers within the specified zone", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "uuid" }, { - "description": "upgrades router with the specified Id", + "description": "upgrades all routers within the specified cluster", "length": 255, - "name": "id", - "related": "destroyRouter,listRouters,rebootRouter,stopRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", + "name": "clusterid", + "related": "addCluster,updateCluster", "required": false, "type": "uuid" }, { - "description": "upgrades all routers within the specified zone", + "description": "upgrades all routers owned by the specified domain", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "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": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } ] }, { @@ -48265,6 +48460,14 @@ "isasync": false, "name": "listIpv4SubnetsForGuestNetwork", "params": [ + { + "description": "UUID of zone Ipv4 subnet which the IPv4 subnet belongs to.", + "length": 255, + "name": "parentid", + "related": "createIpv4SubnetForZone,listIpv4SubnetsForZone,dedicateIpv4SubnetForZone,releaseIpv4SubnetForZone", + "required": false, + "type": "uuid" + }, { "description": "UUID of zone to which the IPv4 subnet belongs to.", "length": 255, @@ -48282,12 +48485,11 @@ "type": "uuid" }, { - "description": "UUID of zone Ipv4 subnet which the IPv4 subnet belongs to.", + "description": "The CIDR of the Ipv4 subnet.", "length": 255, - "name": "parentid", - "related": "createIpv4SubnetForZone,listIpv4SubnetsForZone,dedicateIpv4SubnetForZone,releaseIpv4SubnetForZone", + "name": "subnet", "required": false, - "type": "uuid" + "type": "string" }, { "description": "UUID of the IPv4 subnet for guest network.", @@ -48300,28 +48502,21 @@ { "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" }, { - "description": "The CIDR of the Ipv4 subnet.", + "description": "List by keyword", "length": 255, - "name": "subnet", + "name": "keyword", "required": false, "type": "string" }, @@ -48337,44 +48532,35 @@ "related": "createIpv4SubnetForGuestNetwork", "response": [ { - "description": "name of network which the IPv4 subnet is associated with.", - "name": "networkname", + "description": "id of the data center IPv4 subnet", + "name": "parentid", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, + {}, { "description": "Name of the VPC which the IPv4 subnet is associated with.", "name": "vpcname", "type": "string" }, - {}, { - "description": "date when this IPv4 subnet was removed.", - "name": "removed", - "type": "date" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { "description": "subnet of the data center IPv4 subnet", "name": "parentsubnet", "type": "string" }, { - "description": "id of zone to which the IPv4 subnet belongs to.", - "name": "zoneid", - "type": "string" - }, - { - "description": "id of the data center IPv4 subnet", - "name": "parentid", - "type": "string" + "description": "date when this IPv4 subnet was created.", + "name": "created", + "type": "date" }, { - "description": "Id of the VPC which the IPv4 subnet is associated with.", - "name": "vpcid", + "description": "state of subnet of the IPv4 network", + "name": "state", "type": "string" }, { @@ -48382,40 +48568,49 @@ "name": "id", "type": "string" }, - {}, { - "description": "id of zone to which the IPv4 subnet belongs to.", - "name": "zonename", + "description": "Id of the VPC which the IPv4 subnet is associated with.", + "name": "vpcid", "type": "string" }, { - "description": "date when this IPv4 subnet was created.", - "name": "created", + "description": "date when this IPv4 subnet was allocated.", + "name": "allocated", "type": "date" }, { - "description": "date when this IPv4 subnet was allocated.", - "name": "allocated", + "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 UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "state of subnet of the IPv4 network", - "name": "state", + "description": "id of zone to which the IPv4 subnet belongs to.", + "name": "zonename", "type": "string" }, { - "description": "subnet of the IPv4 network", - "name": "subnet", + "description": "name of network which the IPv4 subnet is associated with.", + "name": "networkname", "type": "string" }, { - "description": "id of network which the IPv4 subnet is associated with.", - "name": "networkid", + "description": "id of zone to which the IPv4 subnet belongs to.", + "name": "zoneid", + "type": "string" + }, + { + "description": "subnet of the IPv4 network", + "name": "subnet", "type": "string" } ], @@ -48430,82 +48625,77 @@ "description": "the host ID", "length": 255, "name": "id", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost,addBaremetalHost", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost", "required": true, "type": "uuid" } ], - "related": "addHost,cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost,addBaremetalHost", + "related": "addBaremetalHost,addHost,cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost", "response": [ { - "description": "the number of CPU sockets on the host", - "name": "cpusockets", - "type": "integer" - }, - { - "description": "CPU Arch of the host", - "name": "arch", + "description": "the OS category ID of the host", + "name": "oscategoryid", "type": "string" }, { - "description": "the host version", - "name": "version", + "description": "the cluster name of the host", + "name": "clustername", "type": "string" }, { - "description": "the last time this host was annotated", - "name": "lastannotated", - "type": "date" + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" }, { - "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", + "description": "comma-separated list of storage access groups on the pod", + "name": "podstorageaccessgroups", "type": "string" }, { - "description": "The name of extension for this cluster", - "name": "extensionname", + "description": "the virtual machine id for host type ConsoleProxy and SecondaryStorageVM", + "name": "virtualmachineid", "type": "string" }, { - "description": "the CPU speed of the host", - "name": "cpuspeed", - "type": "long" + "description": "comma-separated list of storage access groups on the cluster", + "name": "clusterstorageaccessgroups", + "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 hypervisor version", + "name": "hypervisorversion", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the Zone ID of the host", + "name": "zoneid", "type": "string" }, { - "description": "the virtual machine id for host type ConsoleProxy and SecondaryStorageVM", - "name": "virtualmachineid", + "description": "the host version", + "name": "version", "type": "string" }, { - "description": "comma-separated list of storage access groups on the cluster", - "name": "clusterstorageaccessgroups", - "type": "string" + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", + "type": "long" }, { - "description": "the Zone ID of the host", - "name": "zoneid", + "description": "comma-separated list of explicit host tags for the host", + "name": "explicithosttags", "type": "string" }, { - "description": "Total GPUs on the Host", - "name": "gputotal", - "type": "long" + "description": "CPU Arch of the host", + "name": "arch", + "type": "string" }, { - "description": "the amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", - "type": "long" + "description": "true if the host is disconnected. False otherwise.", + "name": "disconnected", + "type": "date" }, { "description": "the host type", @@ -48513,39 +48703,44 @@ "type": "type" }, { - "description": "the management server name of the host", - "name": "managementservername", - "type": "string" + "description": "the host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" }, { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", - "type": "boolean" + "description": "the incoming network traffic on the host", + "name": "networkkbsread", + "type": "long" }, { - "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", - "type": "long" + "description": "true if the host has capability to support UEFI boot", + "name": "ueficapability", + "type": "boolean" }, { - "description": "the management server ID of the host", - "name": "managementserverid", + "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 number of CPU sockets on the host", + "name": "cpusockets", + "type": "integer" }, { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", - "type": "boolean" + "description": "the last annotation set on this host by an admin", + "name": "annotation", + "type": "string" }, { - "description": "The ID of extension for this cluster", - "name": "extensionid", - "type": "string" + "description": "the CPU speed of the host", + "name": "cpuspeed", + "type": "long" + }, + { + "description": "the amount of the host's memory currently allocated in bytes", + "name": "memoryallocatedbytes", + "type": "long" }, { "description": "the cluster type of the cluster that host belongs to", @@ -48553,23 +48748,18 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" + "description": "events available for the host", + "name": "events", + "type": "string" }, { - "description": "the host HA information information", - "name": "hostha", - "type": "hostharesponse" + "description": "the amount of the host's memory currently used", + "name": "memoryused", + "type": "long" }, { - "description": "comma-separated list of storage access groups on the zone", - "name": "zonestorageaccessgroups", + "description": "the admin that annotated this host", + "name": "username", "type": "string" }, { @@ -48578,306 +48768,311 @@ "type": "status" }, { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", + "description": "comma-separated list of storage access groups for the host", + "name": "storageaccessgroups", "type": "string" }, { - "description": "the IP address of the host", - "name": "ipaddress", + "description": "the cluster ID of the host", + "name": "clusterid", "type": "string" }, { - "description": "events available for the host", - "name": "events", - "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": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", + "name": "remainingcapacity", + "type": "long" + }, + { + "description": "Video RAM for this vGPU type", + "name": "videoram", + "type": "long" + }, + { + "description": "Model Name of vGPU", + "name": "vgputype", + "type": "string" + }, + { + "description": "Maximum displays per user", + "name": "maxheads", + "type": "long" + }, + { + "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", + "name": "maxcapacity", + "type": "long" + }, + { + "description": "Maximum no. of vgpu per gpu card (pgpu)", + "name": "maxvgpuperpgpu", + "type": "long" + }, + { + "description": "Maximum X resolution per display", + "name": "maxresolutionx", + "type": "long" + }, + { + "description": "Maximum Y resolution per display", + "name": "maxresolutiony", + "type": "long" + } + ], + "type": "list" + } + ], + "type": "list" }, { - "description": "Host details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the Pod name of the host", + "name": "podname", + "type": "string" }, { - "description": "the OS category name of the host", - "name": "oscategoryname", + "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": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "true if the host supports instance conversion (using virt-v2v)", - "name": "instanceconversionsupported", - "type": "boolean" + "description": "the amount of the host's CPU currently used", + "name": "cpuused", + "type": "string" }, { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", + "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 hypervisor", + "name": "hypervisor", + "type": "string" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "the IP address of the host", + "name": "ipaddress", + "type": "string" }, { - "description": "the cluster name of the host", - "name": "clustername", + "description": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", "type": "string" }, - {}, { - "description": "capabilities of the host", - "name": "capabilities", - "type": "string" + "description": "Used GPUs on the Host", + "name": "gpuused", + "type": "long" }, { - "description": "the amount of the host's CPU currently allocated in MHz", - "name": "cpuallocatedvalue", + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", "type": "long" }, { - "description": "the amount of the host's memory currently used", - "name": "memoryused", + "description": "Total GPUs on the Host", + "name": "gputotal", "type": "long" }, { - "description": "true if the host supports encryption", - "name": "encryptionsupported", - "type": "boolean" + "description": "the date and time the host was last pinged", + "name": "lastpinged", + "type": "date" }, { - "description": "the last annotation set on this host by an admin", - "name": "annotation", + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", "type": "string" }, { - "description": "the date and time the host was created", - "name": "created", - "type": "date" + "description": "Host details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "comma-separated list of implicit host tags for the host", - "name": "implicithosttags", + "description": "the name of the host", + "name": "name", "type": "string" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" + "description": "the resource state of the host", + "name": "resourcestate", + "type": "string" }, - {}, { - "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", + "description": "The ID of extension for this cluster", + "name": "extensionid", "type": "string" }, { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "comma-separated list of storage access groups for the host", - "name": "storageaccessgroups", - "type": "string" + "description": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", + "type": "boolean" }, { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", - "type": "string" + "description": "the last time this host was annotated", + "name": "lastannotated", + "type": "date" }, - {}, { - "description": "comma-separated list of tags for the host", - "name": "hosttags", + "description": "The name of extension for this cluster", + "name": "extensionname", "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 Zone name of the host", - "name": "zonename", - "type": "string" + "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", + "name": "hasenoughcapacity", + "type": "boolean" }, + {}, { - "description": "Used GPUs on the Host", - "name": "gpuused", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the host hypervisor", - "name": "hypervisor", + "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", "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": "the admin that annotated this host", - "name": "username", + "description": "capabilities of the host", + "name": "capabilities", "type": "string" }, { - "description": "GPU cards present in the host", - "name": "gpugroup", - "response": [ - { - "description": "the list of enabled vGPUs", - "name": "vgpu", - "response": [ - { - "description": "Maximum Y resolution per display", - "name": "maxresolutiony", - "type": "long" - }, - { - "description": "Maximum displays per user", - "name": "maxheads", - "type": "long" - }, - { - "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", - "name": "maxcapacity", - "type": "long" - }, - { - "description": "Model Name of vGPU", - "name": "vgputype", - "type": "string" - }, - { - "description": "Maximum X resolution per display", - "name": "maxresolutionx", - "type": "long" - }, - { - "description": "Maximum no. of vgpu per gpu card (pgpu)", - "name": "maxvgpuperpgpu", - "type": "long" - }, - { - "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", - "name": "remainingcapacity", - "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": "true if the host supports instance conversion (using virt-v2v)", + "name": "instanceconversionsupported", + "type": "boolean" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" + "description": "the host HA information information", + "name": "hostha", + "type": "hostharesponse" }, { - "description": "the hypervisor version", - "name": "hypervisorversion", - "type": "string" + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", + "type": "long" }, { "description": "the Pod ID of the host", "name": "podid", "type": "string" }, + { + "description": "the management server ID of the host", + "name": "managementserverid", + "type": "string" + }, { "description": "the cpu average load on the host", "name": "cpuloadaverage", "type": "double" }, + {}, { - "description": "true if the host is disconnected. False otherwise.", - "name": "disconnected", - "type": "date" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", + "name": "suitableformigration", "type": "boolean" }, { - "description": "true if the host has capability to support UEFI boot", - "name": "ueficapability", + "description": "true if the host supports encryption", + "name": "encryptionsupported", "type": "boolean" }, { - "description": "the amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", - "type": "string" - }, - { - "description": "the amount of the host's CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", + "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", "type": "string" }, { - "description": "comma-separated list of storage access groups on the 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": "the CPU number of the host", "name": "cpunumber", "type": "integer" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", + "type": "string" }, { - "description": "the Pod name of the host", - "name": "podname", + "description": "comma-separated list of tags for the host", + "name": "hosttags", "type": "string" }, { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", + "description": "the Zone name of the host", + "name": "zonename", + "type": "string" + }, + { + "description": "the amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", "type": "long" }, { - "description": "the name of the host", - "name": "name", - "type": "string" + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" }, { - "description": "the OS category ID of the host", - "name": "oscategoryid", - "type": "string" + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" }, { - "description": "the cluster ID of the host", - "name": "clusterid", + "description": "the OS category name of the host", + "name": "oscategoryname", "type": "string" }, { "description": "the ID of the host", "name": "id", "type": "string" + }, + { + "description": "the date and time the host was created", + "name": "created", + "type": "date" } ] }, @@ -48887,41 +49082,32 @@ "name": "listVlanIpRanges", "params": [ { - "description": "project who will own the VLAN", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,suspendProject,updateProject", - "required": false, - "type": "uuid" - }, - { - "description": "the ID of the VLAN IP range", + "description": "", "length": 255, - "name": "id", - "related": "createVlanIpRange,updateVlanIpRange,listVlanIpRanges,dedicatePublicIpRange", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "the account with which the VLAN IP range is associated. Must be used with the domainId parameter.", + "description": "the ID or VID of the VLAN. Default is an \"untagged\" VLAN.", "length": 255, - "name": "account", + "name": "vlan", "required": false, "type": "string" }, { - "description": "", + "description": "true if VLAN is of Virtual type, false if Direct", "length": 255, - "name": "page", + "name": "forvirtualnetwork", "required": false, - "type": "integer" + "type": "boolean" }, { "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.", @@ -48932,27 +49118,27 @@ "type": "uuid" }, { - "description": "true if VLAN is of Virtual type, false if Direct", + "description": "the Zone ID of the VLAN IP range", "length": 255, - "name": "forvirtualnetwork", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "physical network id of the VLAN IP range", + "description": "the ID of the VLAN IP range", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", + "name": "id", + "related": "createVlanIpRange,updateVlanIpRange,listVlanIpRanges,dedicatePublicIpRange", "required": false, "type": "uuid" }, { - "description": "network id of the VLAN IP range", + "description": "the account with which the VLAN IP range is associated. Must be used with the domainId parameter.", "length": 255, - "name": "networkid", - "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { "description": "the Pod ID of the VLAN IP range", @@ -48963,24 +49149,33 @@ "type": "uuid" }, { - "description": "", + "description": "project who will own the VLAN", "length": 255, - "name": "pagesize", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,suspendProject,updateProject", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "the ID or VID of the VLAN. Default is an \"untagged\" VLAN.", + "description": "List by keyword", "length": 255, - "name": "vlan", + "name": "keyword", "required": false, "type": "string" }, { - "description": "the Zone ID of the VLAN IP range", + "description": "network id of the VLAN IP range", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "networkid", + "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "required": false, + "type": "uuid" + }, + { + "description": "physical network id of the VLAN IP range", + "length": 255, + "name": "physicalnetworkid", + "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", "required": false, "type": "uuid" } @@ -48988,9 +49183,9 @@ "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", @@ -48998,39 +49193,39 @@ "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the ID or VID of the VLAN.", + "name": "vlan", "type": "string" }, { - "description": "the Zone ID of the VLAN IP range", - "name": "zoneid", + "description": "the start ip of the VLAN IP range", + "name": "startip", "type": "string" }, { - "description": "the start ipv6 of the VLAN IP range", - "name": "startipv6", + "description": "the project id of the vlan range", + "name": "projectid", "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the description of the VLAN IP range", - "name": "description", + "description": "the account of the VLAN IP range", + "name": "account", "type": "string" }, { - "description": "the cidr of the VLAN IP range", - "name": "cidr", + "description": "the netmask of the VLAN IP range", + "name": "netmask", "type": "string" }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { @@ -49039,95 +49234,95 @@ "type": "boolean" }, { - "description": "the end ip of the VLAN IP range", - "name": "endip", + "description": "the Pod name for the VLAN IP range", + "name": "podname", "type": "string" }, { - "description": "the project id of the vlan range", - "name": "projectid", + "description": "the start ipv6 of the VLAN IP range", + "name": "startipv6", "type": "string" }, - {}, { "description": "the Pod ID for the VLAN IP range", "name": "podid", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the cidr of the VLAN IP range", + "name": "cidr", "type": "string" }, { - "description": "the ID or VID of the VLAN.", - "name": "vlan", + "description": "the project name of the vlan range", + "name": "project", "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 gateway of the VLAN IP range", + "name": "gateway", "type": "string" }, { - "description": "the Pod name for the VLAN IP range", - "name": "podname", + "description": "the ID of the VLAN IP range", + "name": "id", "type": "string" }, { - "description": "the project name of the vlan range", - "name": "project", + "description": "the virtual network for the VLAN IP range", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "the end ip of the VLAN IP range", + "name": "endip", "type": "string" }, { - "description": "the end ipv6 of the VLAN IP range", - "name": "endipv6", + "description": "the network id of vlan range", + "name": "networkid", "type": "string" }, { - "description": "the ID of the VLAN IP range", - "name": "id", + "description": "the description of the VLAN IP range", + "name": "description", "type": "string" }, - { - "description": "the virtual network for the VLAN IP range", - "name": "forvirtualnetwork", - "type": "boolean" - }, { "description": "indicates to which provider the IP range is dedicated to", "name": "provider", "type": "string" }, { - "description": "the account of the VLAN IP range", - "name": "account", + "description": "the domain name of the VLAN IP range", + "name": "domain", "type": "string" }, { - "description": "the domain name of the VLAN IP range", - "name": "domain", + "description": "the end ipv6 of the VLAN IP range", + "name": "endipv6", "type": "string" }, { - "description": "the network id of vlan range", - "name": "networkid", + "description": "path of the domain to which the VLAN IP range belongs", + "name": "domainpath", "type": "string" }, { - "description": "the gateway of the VLAN IP range", - "name": "gateway", + "description": "the Zone ID of the VLAN IP range", + "name": "zoneid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ] }, @@ -49137,16 +49332,16 @@ "name": "updateZone", "params": [ { - "description": "the second internal DNS for the Zone", + "description": "the details for the Zone", "length": 255, - "name": "internaldns2", + "name": "details", "required": false, - "type": "string" + "type": "map" }, { - "description": "the dhcp Provider for the Zone", + "description": "the second internal DNS for the Zone", "length": 255, - "name": "dhcpprovider", + "name": "internaldns2", "required": false, "type": "string" }, @@ -49158,23 +49353,16 @@ "type": "string" }, { - "description": "the second DNS for the Zone", - "length": 255, - "name": "dns2", - "required": false, - "type": "string" - }, - { - "description": "the name of the Zone", + "description": "the dns search order list", "length": 255, - "name": "name", + "name": "dnssearchorder", "required": false, - "type": "string" + "type": "list" }, { - "description": "the second DNS for IPv6 network in the Zone", + "description": "the guest CIDR address for the Zone", "length": 255, - "name": "ip6dns2", + "name": "guestcidraddress", "required": false, "type": "string" }, @@ -49186,32 +49374,33 @@ "type": "string" }, { - "description": "the dns search order list", + "description": "the first internal DNS for the Zone", "length": 255, - "name": "dnssearchorder", + "name": "internaldns1", "required": false, - "type": "list" + "type": "string" }, { - "description": "true if local storage offering enabled, false otherwise", + "description": "the ID of the Zone", "length": 255, - "name": "localstorageenabled", - "required": false, - "type": "boolean" + "name": "id", + "related": "createZone,updateZone,listZones,listZones", + "required": true, + "type": "uuid" }, { - "description": "the guest CIDR address for the Zone", + "description": "the first DNS for IPv6 network in the Zone", "length": 255, - "name": "guestcidraddress", + "name": "ip6dns1", "required": false, "type": "string" }, { - "description": "the details for the Zone", + "description": "the second DNS for the Zone", "length": 255, - "name": "details", + "name": "dns2", "required": false, - "type": "map" + "type": "string" }, { "description": "sort key of the zone, integer", @@ -49221,38 +49410,44 @@ "type": "integer" }, { - "description": "the ID of the Zone", + "description": "true if local storage offering enabled, false otherwise", "length": 255, - "name": "id", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" + "name": "localstorageenabled", + "required": false, + "type": "boolean" }, { - "description": "updates a private zone to public if set, but not vice-versa", + "description": "the name of the Zone", "length": 255, - "name": "ispublic", + "name": "name", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "the first DNS for IPv6 network in the Zone", + "description": "the dhcp Provider for the Zone", "length": 255, - "name": "ip6dns1", + "name": "dhcpprovider", "required": false, "type": "string" }, { - "description": "the first DNS for the Zone", + "description": "updates a private zone to public if set, but not vice-versa", "length": 255, - "name": "dns1", + "name": "ispublic", + "required": false, + "type": "boolean" + }, + { + "description": "the second DNS for IPv6 network in the Zone", + "length": 255, + "name": "ip6dns2", "required": false, "type": "string" }, { - "description": "the first internal DNS for the Zone", + "description": "the first DNS for the Zone", "length": 255, - "name": "internaldns1", + "name": "dns1", "required": false, "type": "string" } @@ -49260,43 +49455,48 @@ "related": "createZone,listZones,listZones", "response": [ { - "description": "the second IPv6 DNS for the Zone", - "name": "ip6dns2", + "description": "the UUID of the containing domain, null for public zones", + "name": "domainid", "type": "string" }, { - "description": "Network domain name for the networks in the zone", - "name": "domain", + "description": "External network provider if any", + "name": "provider", "type": "string" }, { - "description": "Meta data associated with the zone (key/value pairs)", - "name": "resourcedetails", - "type": "map" + "description": "Used GPUs in the Zone", + "name": "gpuused", + "type": "long" }, { - "description": "the second internal DNS for the Zone", - "name": "internaldns2", + "description": "comma-separated list of storage access groups for the zone", + "name": "storageaccessgroups", "type": "string" }, { - "description": "Zone Token", - "name": "zonetoken", - "type": "string" + "description": "true if security groups support is enabled, false otherwise", + "name": "securitygroupsenabled", + "type": "boolean" }, { - "description": "Zone description", - "name": "description", + "description": "true, if zone contains clusters and hosts from different CPU architectures", + "name": "ismultiarch", + "type": "boolean" + }, + { + "description": "the first DNS for the Zone", + "name": "dns1", "type": "string" }, { - "description": "the first internal DNS for the Zone", - "name": "internaldns1", + "description": "the second IPv6 DNS for the Zone", + "name": "ip6dns2", "type": "string" }, { - "description": "Zone id", - "name": "id", + "description": "the dhcp Provider for the Zone", + "name": "dhcpprovider", "type": "string" }, { @@ -49305,33 +49505,49 @@ "type": "boolean" }, { - "description": "the allocation state of the cluster", - "name": "allocationstate", + "description": "AS Number Range", + "name": "asnrange", "type": "string" }, { - "description": "the name of the containing domain, null for public zones", - "name": "domainname", + "description": "Zone id", + "name": "id", "type": "string" }, { - "description": "Total GPUs in the Zone", - "name": "gputotal", - "type": "long" + "description": "Zone description", + "name": "description", + "type": "string" }, { - "description": "the UUID of the containing domain, null for public zones", - "name": "domainid", - "type": "string" + "description": "The maximum value the MTU can have on the VR's private interfaces", + "name": "routerprivateinterfacemaxmtu", + "type": "integer" + }, + { + "description": "The maximum value the MTU can have on the VR's public interfaces", + "name": "routerpublicinterfacemaxmtu", + "type": "integer" }, + {}, { "description": "true, if routed network/vpc is enabled", "name": "routedmodeenabled", "type": "boolean" }, { - "description": "the first DNS for the Zone", - "name": "dns1", + "description": "Network domain name for the networks in the zone", + "name": "domain", + "type": "string" + }, + { + "description": "the allocation state of the cluster", + "name": "allocationstate", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -49339,44 +49555,63 @@ "name": "allowuserspecifyvrmtu", "type": "boolean" }, - {}, { - "description": "comma-separated list of storage access groups for the zone", - "name": "storageaccessgroups", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "true if local storage offering enabled, false otherwise", + "name": "localstorageenabled", + "type": "boolean" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the guest CIDR address for the Zone", + "name": "guestcidraddress", "type": "string" }, + { + "description": "Meta data associated with the zone (key/value pairs)", + "name": "resourcedetails", + "type": "map" + }, { "description": "the list of resource tags associated with zone.", "name": "tags", "response": [ { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "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 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 domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -49385,18 +49620,18 @@ "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": "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" }, { @@ -49407,38 +49642,48 @@ ], "type": "set" }, + { + "description": "the second DNS for the Zone", + "name": "dns2", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the second internal DNS for the Zone", + "name": "internaldns2", + "type": "string" + }, { "description": "the capacity of the Zone", "name": "capacity", "response": [ { - "description": "the Pod ID", - "name": "podid", + "description": "the percentage of capacity currently in use", + "name": "percentused", "type": "string" }, { - "description": "the capacity currently in use", - "name": "capacityused", + "description": "the capacity currently in allocated", + "name": "capacityallocated", "type": "long" }, { - "description": "the Cluster name", - "name": "clustername", - "type": "string" - }, - { - "description": "the capacity currently in allocated", - "name": "capacityallocated", + "description": "the total capacity available", + "name": "capacitytotal", "type": "long" }, { - "description": "The tag for the capacity type", - "name": "tag", + "description": "the capacity name", + "name": "name", "type": "string" }, { - "description": "the percentage of capacity currently in use", - "name": "percentused", + "description": "the Cluster name", + "name": "clustername", "type": "string" }, { @@ -49447,18 +49692,8 @@ "type": "string" }, { - "description": "the total capacity available", - "name": "capacitytotal", - "type": "long" - }, - { - "description": "the capacity type", - "name": "type", - "type": "short" - }, - { - "description": "the capacity name", - "name": "name", + "description": "the Pod ID", + "name": "podid", "type": "string" }, { @@ -49475,83 +49710,53 @@ "description": "the Zone name", "name": "zonename", "type": "string" + }, + { + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" + }, + { + "description": "The tag for the capacity type", + "name": "tag", + "type": "string" + }, + { + "description": "the capacity type", + "name": "type", + "type": "short" } ], "type": "list" }, { - "description": "true if security groups support is enabled, false otherwise", - "name": "securitygroupsenabled", - "type": "boolean" - }, - { - "description": "AS Number Range", - "name": "asnrange", + "description": "the network type of the zone; can be Basic or Advanced", + "name": "networktype", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the type of the zone - core or edge", + "name": "type", "type": "string" }, { - "description": "The maximum value the MTU can have on the VR's public interfaces", - "name": "routerpublicinterfacemaxmtu", - "type": "integer" - }, - { - "description": "the display text of the zone", - "name": "displaytext", + "description": "the first internal DNS for the Zone", + "name": "internaldns1", "type": "string" }, { - "description": "true if local storage offering enabled, false otherwise", - "name": "localstorageenabled", - "type": "boolean" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the guest CIDR address for the Zone", - "name": "guestcidraddress", + "description": "the name of the containing domain, null for public zones", + "name": "domainname", "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", + "description": "the display text of the zone", + "name": "displaytext", "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", + "description": "the first IPv6 DNS for the Zone", + "name": "ip6dns1", "type": "string" }, { @@ -49560,26 +49765,16 @@ "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", + "description": "Zone Token", + "name": "zonetoken", "type": "string" }, + {}, { - "description": "the second DNS for the Zone", - "name": "dns2", - "type": "string" - }, - {} + "description": "Total GPUs in the Zone", + "name": "gputotal", + "type": "long" + } ] }, { @@ -49587,13 +49782,6 @@ "isasync": true, "name": "extractVolume", "params": [ - { - "description": "the mode of extraction - HTTP_DOWNLOAD or FTP_UPLOAD", - "length": 255, - "name": "mode", - "required": true, - "type": "string" - }, { "description": "the ID of the zone where the volume is located", "length": 255, @@ -49602,6 +49790,13 @@ "required": true, "type": "uuid" }, + { + "description": "the mode of extraction - HTTP_DOWNLOAD or FTP_UPLOAD", + "length": 255, + "name": "mode", + "required": true, + "type": "string" + }, { "description": "the url to which the volume would be extracted", "length": 2048, @@ -49613,31 +49808,38 @@ "description": "the ID of the volume", "length": 255, "name": "id", - "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", + "related": "importVolume,attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", "required": true, "type": "uuid" } ], - "related": "extractIso,extractSnapshot,extractTemplate,downloadImageStoreObject", + "related": "downloadImageStoreObject,extractIso,extractSnapshot,extractTemplate", "response": [ + {}, { - "description": "the upload id of extracted object", - "name": "extractId", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "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 account id to which the extracted object belongs", + "name": "accountid", "type": "string" }, + {}, { - "description": "the state of the extracted object", - "name": "state", + "description": "", + "name": "resultstring", "type": "string" }, { - "description": "type of the storage", - "name": "storagetype", + "description": "the time and date the object was created", + "name": "created", + "type": "date" + }, + { + "description": "the id of extracted object", + "name": "id", "type": "string" }, { @@ -49645,36 +49847,24 @@ "name": "extractMode", "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 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 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 upload id of extracted object", + "name": "extractId", "type": "string" }, { - "description": "zone ID the object was extracted from", - "name": "zoneid", + "description": "the status of the extraction", + "name": "status", "type": "string" }, { @@ -49683,8 +49873,13 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the percentage of the entity uploaded to the specified location", + "name": "uploadpercentage", + "type": "integer" + }, + { + "description": "zone ID the object was extracted from", + "name": "zoneid", "type": "string" }, { @@ -49693,13 +49888,13 @@ "type": "string" }, { - "description": "the percentage of the entity uploaded to the specified location", - "name": "uploadpercentage", - "type": "integer" + "description": "the state of the extracted object", + "name": "state", + "type": "string" }, { - "description": "the status of the extraction", - "name": "status", + "description": "type of the storage", + "name": "storagetype", "type": "string" } ] @@ -49721,11 +49916,15 @@ "related": "createIpv4SubnetForZone,listIpv4SubnetsForZone,dedicateIpv4SubnetForZone", "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 account of the IPv4 subnet", + "name": "account", + "type": "string" }, - {}, { "description": "the domain ID of the IPv4 subnet", "name": "domainid", @@ -49737,38 +49936,35 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "id of zone to which the IPv4 subnet belongs to.", - "name": "zoneid", + "description": "the project name of the IPv4 subnet", + "name": "project", "type": "string" }, { - "description": "name of zone to which the IPv4 subnet belongs to.", - "name": "zonename", + "description": "guest IPv4 subnet", + "name": "subnet", "type": "string" }, { - "description": "id of the guest IPv4 subnet", - "name": "id", + "description": "the domain name of the IPv4 subnet", + "name": "domain", "type": "string" }, + {}, + {}, { - "description": "the account of the IPv4 subnet", - "name": "account", + "description": "name of zone to which the IPv4 subnet belongs to.", + "name": "zonename", "type": "string" }, { - "description": "the domain name of the IPv4 subnet", - "name": "domain", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the project name of the IPv4 subnet", - "name": "project", + "description": "id of the guest IPv4 subnet", + "name": "id", "type": "string" }, { @@ -49776,10 +49972,9 @@ "name": "created", "type": "date" }, - {}, { - "description": "guest IPv4 subnet", - "name": "subnet", + "description": "id of zone to which the IPv4 subnet belongs to.", + "name": "zoneid", "type": "string" } ], @@ -49790,13 +49985,6 @@ "isasync": false, "name": "listProjectAccounts", "params": [ - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, { "description": "", "length": 255, @@ -49813,20 +50001,11 @@ "type": "uuid" }, { - "description": "ID of the project", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,suspendProject,updateProject", - "required": true, - "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": "uuid" + "type": "string" }, { "description": "", @@ -49836,16 +50015,32 @@ "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 invitation by user ID", "length": 255, - "name": "role", + "name": "userid", + "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", + "required": false, + "type": "uuid" + }, + { + "description": "ID of the project", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,suspendProject,updateProject", + "required": true, + "type": "uuid" + }, + { + "description": "list accounts of the project by account name", + "length": 255, + "name": "account", "required": false, "type": "string" } @@ -49853,78 +50048,64 @@ "related": "activateProject,createProject,suspendProject,updateProject", "response": [ { - "description": "the total number of vpcs available to be created for this project", - "name": "vpcavailable", - "type": "string" - }, - { - "description": "the total number of gpus available to be created for this project", - "name": "gpuavailable", + "description": "the project account name of the project", + "name": "projectaccountname", "type": "string" }, { - "description": "the name of the project", - "name": "name", + "description": "the id of the project", + "name": "id", "type": "string" }, { - "description": "the total number of vpcs the project can own", - "name": "vpclimit", - "type": "string" + "description": "the total number of virtual machines running for this project", + "name": "vmrunning", + "type": "integer" }, { - "description": "the total number of buckets stored by this project", - "name": "buckettotal", - "type": "long" + "description": "the date this project was created", + "name": "created", + "type": "date" }, { - "description": "the total number of snapshots available for this project", - "name": "snapshotavailable", - "type": "string" + "description": "The tagged resource limit and count for the project", + "name": "taggedresources", + "type": "list" }, + {}, { - "description": "the total number of templates which can be created by this project", - "name": "templatelimit", + "description": "the total memory (in MB) available to be created for this project", + "name": "memoryavailable", "type": "string" }, { - "description": "the total number of networks owned by project", - "name": "networktotal", - "type": "long" - }, - { - "description": "the total volume available for this project", - "name": "volumeavailable", + "description": "the total number of virtual machines available for this project to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "the total number of networks the project can own", - "name": "networklimit", + "description": "the total number of backups available to this project", + "name": "backupavailable", "type": "string" }, { - "description": "the total secondary storage space (in GiB) owned by project", - "name": "secondarystoragetotal", - "type": "float" - }, - { - "description": "the total 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 available to be created for this project", - "name": "networkavailable", + "description": "the total backup storage space (in GiB) the project can own", + "name": "backupstoragelimit", "type": "string" }, { - "description": "the total number of buckets available to this project", - "name": "bucketavailable", + "description": "the total volume which can be used by this project", + "name": "volumelimit", "type": "string" }, { - "description": "the total number of gpus owned by project", - "name": "gputotal", + "description": "the total primary storage space (in GiB) owned by project", + "name": "primarystoragetotal", "type": "long" }, { @@ -49933,167 +50114,122 @@ "type": "long" }, { - "description": "the total number of vpcs owned by project", - "name": "vpctotal", - "type": "long" - }, - { - "description": "the total secondary storage space (in GiB) available to be used for this project", - "name": "secondarystorageavailable", - "type": "string" - }, - { - "description": "the total number of public ip addresses allocated for this project", - "name": "iptotal", - "type": "long" - }, - { - "description": "the total backup storage space (in GiB) the project can own", - "name": "backupstoragelimit", - "type": "string" - }, - { - "description": "the total number of virtual machines running for this project", - "name": "vmrunning", - "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 total memory (in MB) available to be created for this project", - "name": "memoryavailable", - "type": "string" - }, - { - "description": "the total number of backups which can be stored by this project", - "name": "backuplimit", + "description": "the total number of cpu cores the project can own", + "name": "cpulimit", "type": "string" }, { - "description": "the total volume which can be used by this project", - "name": "volumelimit", + "description": "the total number of buckets available to this project", + "name": "bucketavailable", "type": "string" }, { - "description": "the state of the project", - "name": "state", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the total number of templates available to be created by this project", - "name": "templateavailable", + "description": "the total number of virtual machines that can be deployed by this project", + "name": "vmlimit", "type": "string" }, { - "description": "the total object storage space (in GiB) available to the project", - "name": "objectstorageavailable", + "description": "the domain name where the project belongs to", + "name": "domain", "type": "string" }, { - "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 project", + "name": "secondarystoragetotal", + "type": "float" }, { - "description": "the total number of virtual machines that can be deployed by this project", - "name": "vmlimit", - "type": "string" + "description": "the total number of public ip addresses allocated for this project", + "name": "iptotal", + "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total object storage space (in GiB) the project can own", + "name": "objectstoragelimit", "type": "string" }, { - "description": "the project account name of the project", - "name": "projectaccountname", - "type": "string" + "description": "the total number of virtual machines stopped for this project", + "name": "vmstopped", + "type": "integer" }, { - "description": "the total volume being used by this project", - "name": "volumetotal", + "description": "the total backup storage space (in GiB) owned by the project", + "name": "backupstoragetotal", "type": "long" }, { - "description": "the total number of backups available to this project", - "name": "backupavailable", + "description": "the total number of cpu cores available to be created for this project", + "name": "cpuavailable", "type": "string" }, { - "description": "the domain id the project belongs to", - "name": "domainid", - "type": "string" + "description": "the total number of snapshots stored by this project", + "name": "snapshottotal", + "type": "long" }, { - "description": "the domain name where the project belongs to", - "name": "domain", - "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", + "description": "the total number of templates available to be created by this project", + "name": "templateavailable", "type": "string" }, { - "description": "the total number of cpu cores owned by project", - "name": "cputotal", + "description": "the total volume being used by this project", + "name": "volumetotal", "type": "long" }, { - "description": "the total number of virtual machines deployed by this project", - "name": "vmtotal", + "description": "the total number of vpcs owned by project", + "name": "vpctotal", "type": "long" }, { - "description": "the total number of gpus the project can own", - "name": "gpulimit", - "type": "string" - }, - { - "description": "the id of the project", - "name": "id", + "description": "the total secondary storage space (in GiB) available to be used for this project", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "the displaytext of the project", - "name": "displaytext", + "description": "the total number of templates which can be created by this project", + "name": "templatelimit", "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by project", - "name": "primarystoragetotal", + "description": "the total number of networks owned by project", + "name": "networktotal", "type": "long" }, { - "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", + "type": "string" }, { "description": "the list of resource tags associated with vm", "name": "tags", "response": [ { - "description": "tag key name", - "name": "key", + "description": "tag value", + "name": "value", "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": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { @@ -50102,64 +50238,82 @@ "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", + "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": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "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" } ], "type": "list" }, - {}, + { + "description": "the total number of gpus the project can own", + "name": "gpulimit", + "type": "string" + }, + { + "description": "the total volume available for this project", + "name": "volumeavailable", + "type": "string" + }, + { + "description": "the displaytext of the project", + "name": "displaytext", + "type": "string" + }, + { + "description": "the total number of gpus available to be created for this project", + "name": "gpuavailable", + "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": "the total object storage space (in GiB) owned by the project", + "name": "objectstoragetotal", + "type": "long" }, { - "description": "the total number of virtual machines available for this project to acquire", - "name": "vmavailable", + "description": "the total number of snapshots which can be stored by this project", + "name": "snapshotlimit", "type": "string" }, { - "description": "the total number of virtual machines stopped for this project", - "name": "vmstopped", - "type": "integer" + "description": "the total primary storage space (in GiB) available to be used for this project", + "name": "primarystorageavailable", + "type": "string" }, { "description": "the total memory (in MB) owned by project", @@ -50172,64 +50326,105 @@ "type": "string" }, { - "description": "the total primary storage space (in GiB) available to be used for this project", - "name": "primarystorageavailable", + "description": "the total object storage space (in GiB) available to the project", + "name": "objectstorageavailable", "type": "string" }, { - "description": "the total number of snapshots which can be stored by this project", - "name": "snapshotlimit", + "description": "the total number of snapshots available for this project", + "name": "snapshotavailable", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the total number of networks the project can own", + "name": "networklimit", + "type": "string" }, { - "description": "the total object storage space (in GiB) the project can own", - "name": "objectstoragelimit", + "description": "the total secondary storage space (in GiB) the project can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "the total number of cpu cores the project can own", - "name": "cpulimit", + "description": "the name of the project", + "name": "name", "type": "string" }, { - "description": "the total primary storage space (in GiB) the project can own", - "name": "primarystoragelimit", + "description": "the total number of buckets stored by this project", + "name": "buckettotal", + "type": "long" + }, + { + "description": "the domain id the project belongs to", + "name": "domainid", "type": "string" }, { - "description": "the total number of snapshots stored by this project", - "name": "snapshottotal", - "type": "long" + "description": "the total number of public ip addresses this project can acquire", + "name": "iplimit", + "type": "string" }, { - "description": "The tagged resource limit and count for the project", - "name": "taggedresources", - "type": "list" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the total number of cpu cores available to be created for this project", - "name": "cpuavailable", + "description": "the total number of vpcs available to be created for this project", + "name": "vpcavailable", "type": "string" }, { - "description": "the total backup storage space (in GiB) owned by the project", - "name": "backupstoragetotal", + "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 total memory (in MB) the project can own", + "name": "memorylimit", + "type": "string" + }, { "description": "the total number of buckets which can be stored by this project", "name": "bucketlimit", "type": "string" }, { - "description": "the total object storage space (in GiB) owned by the project", - "name": "objectstoragetotal", + "description": "the total number of networks available to be created for this project", + "name": "networkavailable", + "type": "string" + }, + { + "description": "the total number of virtual machines deployed by this project", + "name": "vmtotal", + "type": "long" + }, + { + "description": "the state of the project", + "name": "state", + "type": "string" + }, + {}, + { + "description": "the total number of vpcs the project can own", + "name": "vpclimit", + "type": "string" + }, + { + "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", + "type": "string" } ], "since": "3.0.0" @@ -50239,6 +50434,21 @@ "isasync": true, "name": "updateAutoScalePolicy", "params": [ + { + "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" + }, { "description": "the duration in which the conditions have to be true before action is taken", "length": 255, @@ -50261,34 +50471,14 @@ "related": "listAutoScalePolicies,updateAutoScalePolicy", "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", "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", - "type": "string" + "description": "the duration for which the conditions have to be true before action is taken", + "name": "duration", + "type": "integer" }, { "description": "the autoscale policy ID", @@ -50296,20 +50486,19 @@ "type": "string" }, { - "description": "the account owning the autoscale policy", - "name": "account", - "type": "string" + "description": "the list of IDs of the conditions that are being evaluated on every interval", + "name": "conditions", + "type": "list" }, - {}, { - "description": "the domain name of the autoscale policy", - "name": "domain", - "type": "string" + "description": "the cool down period for which the policy should not be evaluated after the action has been taken", + "name": "quiettime", + "type": "integer" }, { - "description": "the 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 name of the autoscale policy", @@ -50317,39 +50506,45 @@ "type": "string" }, { - "description": "name of the autoscale policy", - "name": "name", + "description": "the domain ID of the autoscale policy", + "name": "domainid", "type": "string" }, { - "description": "the action to be executed if all the conditions evaluate to true for the specified duration.", - "name": "action", + "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", - "type": "integer" + "description": "the action to be executed if all the conditions evaluate to true for the specified duration.", + "name": "action", + "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 duration for which the conditions have to be true before action is taken", - "name": "duration", + "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 UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the domain ID of the autoscale policy", - "name": "domainid", + "description": "the account owning the autoscale policy", + "name": "account", + "type": "string" + }, + { + "description": "path of the domain to which the autoscale policy belongs", + "name": "domainpath", "type": "string" } ] @@ -50359,21 +50554,6 @@ "isasync": true, "name": "createIpv4SubnetForZone", "params": [ - { - "description": "project who will own the IPv4 subnet", - "length": 255, - "name": "projectid", - "related": "activateProject,createProject,suspendProject,updateProject", - "required": false, - "type": "uuid" - }, - { - "description": "The CIDR of the IPv4 subnet.", - "length": 255, - "name": "subnet", - "required": true, - "type": "string" - }, { "description": "account who will own the IPv4 subnet", "length": 255, @@ -50389,6 +50569,13 @@ "required": true, "type": "uuid" }, + { + "description": "The CIDR of the IPv4 subnet.", + "length": 255, + "name": "subnet", + "required": true, + "type": "string" + }, { "description": "domain ID of the account owning the IPv4 subnet", "length": 255, @@ -50396,30 +50583,22 @@ "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, "type": "uuid" + }, + { + "description": "project who will own the IPv4 subnet", + "length": 255, + "name": "projectid", + "related": "activateProject,createProject,suspendProject,updateProject", + "required": false, + "type": "uuid" } ], "related": "listIpv4SubnetsForZone,dedicateIpv4SubnetForZone", "response": [ - { - "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": "id of zone to which the IPv4 subnet belongs to.", - "name": "zoneid", - "type": "string" - }, {}, { - "description": "the domain ID of the IPv4 subnet", - "name": "domainid", + "description": "the account of the IPv4 subnet", + "name": "account", "type": "string" }, { @@ -50433,8 +50612,8 @@ "type": "string" }, { - "description": "the domain name of the IPv4 subnet", - "name": "domain", + "description": "the project name of the IPv4 subnet", + "name": "project", "type": "string" }, { @@ -50443,8 +50622,8 @@ "type": "string" }, { - "description": "the project name of the IPv4 subnet", - "name": "project", + "description": "the domain name of the IPv4 subnet", + "name": "domain", "type": "string" }, { @@ -50452,14 +50631,30 @@ "name": "zonename", "type": "string" }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "id of zone to which the IPv4 subnet belongs to.", + "name": "zoneid", + "type": "string" + }, { "description": "the project id of the IPv4 subnet", "name": "projectid", "type": "string" }, { - "description": "the account of the IPv4 subnet", - "name": "account", + "description": "date when this IPv4 subnet was created.", + "name": "created", + "type": "date" + }, + { + "description": "the domain ID of the IPv4 subnet", + "name": "domainid", "type": "string" } ], @@ -50470,13 +50665,6 @@ "isasync": false, "name": "createDiskOffering", "params": [ - { - "description": "the storage type of the disk offering. Values are local and shared.", - "length": 255, - "name": "storagetype", - "required": false, - "type": "string" - }, { "description": "An alternate display text of the disk offering, defaults to 'name'.", "length": 4096, @@ -50485,73 +50673,67 @@ "type": "string" }, { - "description": "Volumes using this offering should be encrypted", + "description": "max iops of the disk offering", "length": 255, - "name": "encrypt", + "name": "maxiops", "required": false, - "since": "4.18", - "type": "boolean" + "type": "long" }, { - "description": "the cache mode to use for this disk offering. none, writeback or writethrough", + "description": "name of the disk offering", "length": 255, - "name": "cachemode", - "required": false, - "since": "4.14", + "name": "name", + "required": true, "type": "string" }, { - "description": "To allow or disallow the resize operation on the disks created from this disk offering, if the flag is true then resize is not allowed", + "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", "length": 255, - "name": "disksizestrictness", + "name": "hypervisorsnapshotreserve", "required": false, - "since": "4.17", - "type": "boolean" + "type": "integer" }, { "description": "length (in seconds) of the burst", "length": 255, - "name": "iopswriteratemaxlength", + "name": "iopsreadratemaxlength", "required": false, "type": "long" }, { - "description": "name of the disk offering", + "description": "burst bytes read rate of the disk offering", "length": 255, - "name": "name", - "required": true, - "type": "string" + "name": "bytesreadratemax", + "required": false, + "type": "long" }, { - "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", + "description": "burst bytes write rate of the disk offering", "length": 255, - "name": "provisioningtype", + "name": "byteswriteratemax", "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": "io requests write rate of the disk offering", "length": 255, - "name": "details", + "name": "iopswriterate", "required": false, - "since": "4.16", - "type": "map" + "type": "long" }, { - "description": "the ID of the containing zone(s), null for public offerings", + "description": "whether disk offering size is custom or not", "length": 255, - "name": "zoneid", - "related": "createZone,listZones,listZones", + "name": "customized", "required": false, - "since": "4.13", - "type": "list" + "type": "boolean" }, { "description": "the ID of the containing domain(s), null for public offerings", @@ -50562,18 +50744,21 @@ "type": "list" }, { - "description": "whether disk offering size is custom or not", + "description": "Name of the storage policy defined at vCenter, this is applicable only for VMware", "length": 255, - "name": "customized", + "name": "storagepolicy", + "related": "listVsphereStoragePolicies", "required": false, - "type": "boolean" + "since": "4.15", + "type": "uuid" }, { - "description": "burst requests read rate of the disk offering", + "description": "details to specify disk offering parameters", "length": 255, - "name": "iopsreadratemax", + "name": "details", "required": false, - "type": "long" + "since": "4.16", + "type": "map" }, { "description": "an optional field, whether to display the offering to the end user or not.", @@ -50583,60 +50768,62 @@ "type": "boolean" }, { - "description": "length (in seconds) of the burst", + "description": "burst io requests write rate of the disk offering", "length": 255, - "name": "iopsreadratemaxlength", + "name": "iopswriteratemax", "required": false, "type": "long" }, { - "description": "burst bytes write rate of the disk offering", + "description": "io requests read rate of the disk offering", "length": 255, - "name": "byteswriteratemax", + "name": "iopsreadrate", "required": false, "type": "long" }, { - "description": "length (in seconds) of the burst", + "description": "min iops of the disk offering", "length": 255, - "name": "bytesreadratemaxlength", + "name": "miniops", "required": false, "type": "long" }, { - "description": "max iops of the disk offering", + "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": "maxiops", + "name": "cachemode", "required": false, - "type": "long" + "since": "4.14", + "type": "string" }, { - "description": "burst io requests write rate of the disk offering", + "description": "size of the disk offering in GB (1GB = 1,073,741,824 bytes)", "length": 255, - "name": "iopswriteratemax", + "name": "disksize", "required": false, "type": "long" }, { - "description": "burst bytes read rate of the disk offering", + "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", "length": 255, - "name": "bytesreadratemax", + "name": "provisioningtype", "required": false, - "type": "long" + "type": "string" }, { - "description": "io requests write rate of the disk offering", + "description": "length (in seconds) of the burst", "length": 255, - "name": "iopswriterate", + "name": "iopswriteratemaxlength", "required": false, "type": "long" }, { - "description": "io requests read rate of the disk offering", + "description": "To allow or disallow the resize operation on the disks created from this disk offering, if the flag is true then resize is not allowed", "length": 255, - "name": "iopsreadrate", + "name": "disksizestrictness", "required": false, - "type": "long" + "since": "4.17", + "type": "boolean" }, { "description": "bytes read rate of the disk offering", @@ -50646,53 +50833,61 @@ "type": "long" }, { - "description": "bytes write rate of the disk offering", + "description": "the ID of the containing zone(s), null for public offerings", "length": 255, - "name": "byteswriterate", + "name": "zoneid", + "related": "createZone,listZones,listZones", "required": false, - "type": "long" + "since": "4.13", + "type": "list" }, { - "description": "whether disk offering iops is custom or not", + "description": "bytes write rate of the disk offering", "length": 255, - "name": "customizediops", + "name": "byteswriterate", "required": false, - "type": "boolean" + "type": "long" }, { - "description": "tags for the disk offering", - "length": 4096, - "name": "tags", + "description": "the storage type of the disk offering. Values are local and shared.", + "length": 255, + "name": "storagetype", "required": false, "type": "string" }, { "description": "length (in seconds) of the burst", "length": 255, - "name": "byteswriteratemaxlength", + "name": "bytesreadratemaxlength", "required": false, "type": "long" }, { - "description": "Name of the storage policy defined at vCenter, this is applicable only for VMware", + "description": "burst requests read rate of the disk offering", "length": 255, - "name": "storagepolicy", - "related": "listVsphereStoragePolicies", + "name": "iopsreadratemax", "required": false, - "since": "4.15", - "type": "uuid" + "type": "long" }, { - "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", + "description": "Volumes using this offering should be encrypted", "length": 255, - "name": "hypervisorsnapshotreserve", + "name": "encrypt", "required": false, - "type": "integer" + "since": "4.18", + "type": "boolean" }, { - "description": "min iops of the disk offering", + "description": "tags for the disk offering", + "length": 4096, + "name": "tags", + "required": false, + "type": "string" + }, + { + "description": "length (in seconds) of the burst", "length": 255, - "name": "miniops", + "name": "byteswriteratemaxlength", "required": false, "type": "long" } @@ -50700,14 +50895,14 @@ "related": "", "response": [ { - "description": "burst io requests write rate of the disk offering", - "name": "diskIopsWriteRateMax", + "description": "length (in seconds) of the burst", + "name": "diskBytesReadRateMaxLength", "type": "long" }, { - "description": "the vsphere storage policy tagged to the disk offering in case of VMware", - "name": "vspherestoragepolicy", - "type": "string" + "description": "length (in seconds) of the burst", + "name": "diskBytesWriteRateMaxLength", + "type": "long" }, { "description": "the date this disk offering was created", @@ -50715,85 +50910,79 @@ "type": "date" }, { - "description": "length (in second) of the burst", - "name": "diskIopsReadRateMaxLength", + "description": "io requests write rate of the disk offering", + "name": "diskIopsWriteRate", "type": "long" }, { - "description": "bytes read rate of the disk offering", - "name": "diskBytesReadRate", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "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", - "type": "long" - }, { "description": "state of the disk offering", "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": "bytes write rate of the disk offering", - "name": "diskBytesWriteRate", + "description": "the min iops of the disk offering", + "name": "miniops", "type": "long" }, { - "description": "true if disk offering uses custom iops, false otherwise", - "name": "iscustomizediops", - "type": "boolean" + "description": "bytes read rate of the disk offering", + "name": "diskBytesReadRate", + "type": "long" }, { - "description": "length (in seconds) of the burst", - "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": "Whether disks using this offering will be encrypted on primary storage", - "name": "encrypt", - "type": "boolean" + "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", + "name": "provisioningtype", + "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": "length (in seconds) of the burst", - "name": "diskBytesReadRateMaxLength", + "description": "burst bytes write rate of the disk offering", + "name": "diskBytesWriteRateMax", "type": "long" }, - {}, { - "description": "the size of the disk offering in GB", - "name": "disksize", - "type": "long" + "description": "true if disk offering uses custom iops, false otherwise", + "name": "iscustomizediops", + "type": "boolean" }, { - "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": "burst io requests read rate of the disk offering", - "name": "diskIopsReadRateMax", + "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domainid", + "type": "string" + }, + { + "description": "length (in second) of the burst", + "name": "diskIopsReadRateMaxLength", "type": "long" }, - {}, { - "description": "the min iops of the disk offering", - "name": "miniops", + "description": "io requests read rate of the disk offering", + "name": "diskIopsReadRate", "type": "long" }, { @@ -50802,94 +50991,100 @@ "type": "string" }, { - "description": "additional key/value details tied with this disk offering", - "name": "details", - "type": "map" - }, - { - "description": "burst bytes write rate of the disk offering", - "name": "diskBytesWriteRateMax", + "description": "the size of the disk offering in GB", + "name": "disksize", "type": "long" }, { - "description": "the cache mode to use for this disk offering. none, writeback or writethrough", - "name": "cacheMode", - "type": "string" - }, - { - "description": "the storage type for this disk offering", - "name": "storagetype", - "type": "string" + "description": "length (in seconds) of the burst", + "name": "diskIopsWriteRateMaxLength", + "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 tags for the disk offering", + "name": "tags", "type": "string" }, { - "description": "unique ID of the disk offering", - "name": "id", - "type": "string" + "description": "Whether disks using this offering will be encrypted on primary storage", + "name": "encrypt", + "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if disk offering uses custom size, false otherwise", + "name": "iscustomized", + "type": "boolean" }, { "description": "the max iops of the disk offering", "name": "maxiops", "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": "Returns true if the disk offering is suitable for the given virtual machine for disk creation otherwise false", "name": "suitableforvirtualmachine", "type": "boolean" }, { - "description": "length (in seconds) of the burst", - "name": "diskBytesWriteRateMaxLength", + "description": "burst bytes read rate of the disk offering", + "name": "diskBytesReadRateMax", "type": "long" }, { - "description": "io requests read rate of the disk offering", - "name": "diskIopsReadRate", + "description": "bytes write rate of the disk offering", + "name": "diskBytesWriteRate", "type": "long" }, { - "description": "the tags for the disk offering", - "name": "tags", - "type": "string" + "description": "whether to display the offering to the end user or not.", + "name": "displayoffering", + "type": "boolean" }, { - "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zoneid", + "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": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the cache mode to use for this disk offering. none, writeback or writethrough", + "name": "cacheMode", "type": "string" }, { - "description": "the name of the disk offering", - "name": "name", + "description": "burst io requests read rate of the disk offering", + "name": "diskIopsReadRateMax", + "type": "long" + }, + { + "description": "unique ID of the disk offering", + "name": "id", "type": "string" }, { - "description": "true if disk offering uses custom size, false otherwise", - "name": "iscustomized", - "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": "whether to display the offering to the end user or not.", - "name": "displayoffering", - "type": "boolean" + "description": "burst io requests write rate of the disk offering", + "name": "diskIopsWriteRateMax", + "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 disk offering", + "name": "name", + "type": "string" }, { "description": "true if the entity/resource has annotations", @@ -50897,9 +51092,9 @@ "type": "boolean" }, { - "description": "To allow or disallow the resize operation on the disks created from this disk offering, if the flag is true then resize is not allowed", - "name": "disksizestrictness", - "type": "boolean" + "description": "the vsphere storage policy tagged to the disk offering in case of VMware", + "name": "vspherestoragepolicy", + "type": "string" } ] }, @@ -50918,6 +51113,16 @@ ], "related": "", "response": [ + { + "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" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -50928,27 +51133,17 @@ "name": "jobid", "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 description of the protocol parameter", "name": "description", "type": "string" }, + {}, { - "description": "the index (ID, Value, Code, Type, Option, etc) of the protocol parameter", - "name": "index", - "type": "integer" + "description": "the details of the protocol parameter", + "name": "details", + "type": "map" } ], "since": "4.19.0" @@ -50959,42 +51154,35 @@ "name": "listLBHealthCheckPolicies", "params": [ { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "", + "description": "the ID of the health check policy", "length": 255, - "name": "page", + "name": "id", + "related": "createLBHealthCheckPolicy,listLBHealthCheckPolicies", "required": false, - "type": "integer" + "since": "4.4", + "type": "uuid" }, { "description": "the ID of the load balancer rule", "length": 255, "name": "lbruleid", - "related": "createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,updateIpv6FirewallRule", + "related": "createRoutingFirewallRule,listRoutingFirewallRules,updateIpv6FirewallRule,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule", "required": false, "type": "uuid" }, { - "description": "the ID of the health check policy", + "description": "", "length": 255, - "name": "id", - "related": "createLBHealthCheckPolicy,listLBHealthCheckPolicies", + "name": "pagesize", "required": false, - "since": "4.4", - "type": "uuid" + "type": "integer" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", @@ -51003,13 +51191,30 @@ "required": false, "since": "4.4", "type": "boolean" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" } ], "related": "createLBHealthCheckPolicy", "response": [ { - "description": "the account of the HealthCheck policy", - "name": "account", + "description": "the domain of the HealthCheck policy", + "name": "domain", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the id of the zone the HealthCheck policy belongs to", + "name": "zoneid", "type": "string" }, { @@ -51017,19 +51222,19 @@ "name": "healthcheckpolicy", "response": [ { - "description": "Amount of time between health checks", - "name": "healthcheckinterval", - "type": "int" + "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", - "type": "int" + "description": "the LB HealthCheck policy ID", + "name": "id", + "type": "string" }, { - "description": "Number of consecutive health check failures before declaring an instance unhealthy.", - "name": "unhealthcheckthresshold", - "type": "int" + "description": "is policy for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { "description": "the pingpath of the healthcheck policy", @@ -51037,24 +51242,24 @@ "type": "string" }, { - "description": "the description of the healthcheck policy", - "name": "description", - "type": "string" + "description": "Time to wait when receiving a response from the health check", + "name": "responsetime", + "type": "int" }, { - "description": "is policy for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "Amount of time between health checks", + "name": "healthcheckinterval", + "type": "int" }, { - "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" }, { - "description": "the LB HealthCheck policy ID", - "name": "id", - "type": "string" + "description": "Number of consecutive health check failures before declaring an instance unhealthy.", + "name": "unhealthcheckthresshold", + "type": "int" }, { "description": "the state of the policy", @@ -51065,16 +51270,16 @@ "type": "list" }, {}, - {}, { - "description": "the LB rule ID", - "name": "lbruleid", + "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 domain ID of the HealthCheck policy", @@ -51082,85 +51287,452 @@ "type": "string" }, { - "description": "the domain of the HealthCheck policy", - "name": "domain", + "description": "the LB rule ID", + "name": "lbruleid", "type": "string" + } + ], + "since": "4.2.0" + }, + { + "description": "Attempts Migration of a VM with its volumes to a different host", + "isasync": true, + "name": "migrateVirtualMachineWithVolume", + "params": [ + { + "description": "the ID of the virtual machine", + "length": 255, + "name": "virtualmachineid", + "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,createVMFromBackup,createVMFromBackup,assignVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", + "required": true, + "type": "uuid" + }, + { + "description": "Destination Host ID to migrate VM to.", + "length": 255, + "name": "hostid", + "related": "addBaremetalHost,addHost,cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost", + "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, + "name": "migrateto", + "required": false, + "type": "map" + }, + { + "description": "Automatically select a destination host for a running instance, if hostId is not specified. false by default", + "length": 255, + "name": "autoselect", + "required": false, + "since": "4.19.0", + "type": "boolean" + } + ], + "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,createVMFromBackup,createVMFromBackup,assignVirtualMachine,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", + "response": [ + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "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 list of ingress rules associated with the security group", + "name": "ingressrule", + "response": [ + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the 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": "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 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" + } + ], + "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": "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 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": "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 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": "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": "the domain associated with the tag", + "name": "domain", + "type": "string" + } + ], + "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 code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "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": "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": "resource type", + "name": "resourcetype", + "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 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": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + } + ], + "type": "set" + }, + { + "description": "the project name of the group", + "name": "project", + "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 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 domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "the name of the security group", + "name": "name", + "type": "string" + }, + { + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "the description of the security group", + "name": "description", + "type": "string" + } + ], + "type": "set" }, { - "description": "the id of the zone the HealthCheck policy belongs to", - "name": "zoneid", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } - ], - "since": "4.2.0" - }, - { - "description": "Attempts Migration of a VM with its volumes to a different host", - "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": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "Destination Host ID to migrate VM to.", - "length": 255, - "name": "hostid", - "related": "addHost,cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost,addBaremetalHost", - "required": false, - "type": "uuid" + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, { - "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, - "name": "migrateto", - "required": false, - "type": "map" + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" }, { - "description": "Automatically select a destination host for a running instance, if hostId is not specified. false by default", - "length": 255, - "name": "autoselect", - "required": false, - "since": "4.19.0", - "type": "boolean" - } - ], - "related": "assignVirtualMachine,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", - "response": [ - { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "the password (if exists) of the virtual machine", + "name": "password", + "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "the ID of the vgpu profile to which service offering is linked", - "name": "vgpuprofileid", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { @@ -51169,92 +51741,72 @@ "type": "long" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" - }, - { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" - }, - { - "description": "the group name of the virtual machine", - "name": "group", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", "type": "boolean" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", - "type": "string" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the 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": "OS type id of the vm", - "name": "ostypeid", + "description": "the state of the virtual machine", + "name": "state", "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 name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "the account associated with the tag", - "name": "account", + "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": "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": "tag key name", - "name": "key", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -51263,71 +51815,71 @@ "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 project id the tag belongs to", - "name": "projectid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "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" } ], "type": "set" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the project name of the vm", + "name": "project", + "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": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "the maximum X resolution", - "name": "maxresolutionx", - "type": "long" + "description": "User VM type", + "name": "vmtype", + "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { @@ -51336,196 +51888,103 @@ "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 template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "List of 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 name of the host for the virtual machine", - "name": "hostname", + "description": "the project id of the vm", + "name": "projectid", "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 ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "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 total number of network traffic bytes received", - "name": "receivedbytes", + "description": "device ID of the root volume", + "name": "rootdeviceid", "type": "long" }, - {}, { "description": "the userdata override policy with the userdata provided while deploying VM", "name": "userdatapolicy", "type": "string" }, { - "description": "the name of the vgpu profile to which service offering is linked", - "name": "vgpuprofilename", - "type": "string" - }, - { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "description": "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": "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 ID of the affinity group", - "name": "id", - "type": "string" - }, - { - "description": "the name of the affinity group", - "name": "name", - "type": "string" - }, - { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" - }, - { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" - }, - { - "description": "the project ID of the affinity group", - "name": "projectid", - "type": "string" - }, - { - "description": "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" - } - ], - "type": "set" + "description": "the maximum X resolution", + "name": "maxresolutionx", + "type": "long" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", - "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", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "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", + "description": "true if vm has delete protection.", + "name": "deleteprotection", "type": "boolean" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" - }, - { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "the group name of the virtual machine", + "name": "group", "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", + "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": "the format of the template for the virtual machine", - "name": "templateformat", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "OS name of the vm", + "name": "osdisplayname", "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": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { @@ -51534,34 +51993,30 @@ "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", + "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", + "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 project name of the vm", - "name": "project", - "type": "string" + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" }, { - "description": "the account associated with the virtual machine", - "name": "account", - "type": "string" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { "description": "the read (IO) of disk on the VM", @@ -51569,38 +52024,39 @@ "type": "long" }, { - "description": "true if vm has delete protection.", - "name": "deleteprotection", - "type": "boolean" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "User VM type", - "name": "vmtype", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", "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 user's ID who deployed the virtual machine", - "name": "userid", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, + {}, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { @@ -51608,171 +52064,157 @@ "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 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": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" - }, - { - "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 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 template for the virtual machine", + "name": "templatename", "type": "string" }, { - "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": "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", + "type": "long" }, { - "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 broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "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": "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": "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": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the type of the affinity group", + "name": "type", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", "type": "list" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + } + ], + "type": "set" + }, + { + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", + "type": "string" + }, + { + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", + "type": "string" + }, + { + "description": "Instance lease duration in days", + "name": "leaseduration", + "type": "integer" + }, + { + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", + "type": "string" + }, + { + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", + "type": "string" + }, + { + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" + }, + { + "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 memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, + { + "description": "the list of nics associated with vm", + "name": "nic", + "response": [ { - "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": "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 ip address of the nic", - "name": "ipaddress", - "type": "string" + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { "description": "the ID of the nic", @@ -51780,13 +52222,13 @@ "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the type of the nic", + "name": "type", "type": "string" }, { @@ -51795,8 +52237,8 @@ "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { @@ -51805,494 +52247,247 @@ "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" - } - ], - "type": "set" - }, - { - "description": "the password (if exists) of the virtual machine", - "name": "password", - "type": "string" - }, - { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" - }, - { - "description": "device type of the root volume", - "name": "rootdevicetype", - "type": "string" - }, - { - "description": "the video RAM size in MB", - "name": "videoram", - "type": "long" - }, - { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", - "response": [ - { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the 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 code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - } - ], - "type": "set" + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" }, { - "description": "the domain name of the security group", - "name": "domain", + "description": "the ip address of the nic", + "name": "ipaddress", "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": "the isolation uri of the nic", + "name": "isolationuri", "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 isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" }, { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" }, { - "description": "the account owning the security group", - "name": "account", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "the project name of the group", - "name": "project", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" }, { - "description": "the ID of the security group", - "name": "id", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "the name of the security group", - "name": "name", + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" } ], "type": "set" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", - "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", + "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", + "description": "the video RAM size in MB", + "name": "videoram", + "type": "long" + }, + { + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "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": "Base64 string containing the user data", - "name": "userdata", + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "the VM's primary IP address", + "name": "ipaddress", "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" + "description": "the name of userdata used for the VM", + "name": "userdataname", + "type": "string" }, { - "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": "CPU arch of the VM", - "name": "arch", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "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 number of display heads", + "name": "maxheads", "type": "long" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the name of the gpu card to which service offering is linked", - "name": "gpucardname", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the ID of the gpu card to which service offering is linked", - "name": "gpucardid", + "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 availability zone for the virtual machine", - "name": "zonename", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", "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", + "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", + "description": "the count of GPUs on the virtual machine", + "name": "gpucount", "type": "integer" }, { - "description": " 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 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 name of the backup offering of the virtual machine", - "name": "backupofferingname", - "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", + "type": "integer" } ] }, @@ -52301,13 +52496,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, @@ -52316,62 +52504,61 @@ "type": "string" }, { - "description": "Whether to list removed themes.", + "description": "The ID of the account to be filtered.", "length": 255, - "name": "showremoved", + "name": "accountid", + "related": "disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "The name of the theme.", + "description": "", "length": 255, - "name": "name", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "", + "description": "Whether to list public themes.", "length": 255, - "name": "pagesize", + "name": "showpublic", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "The ID of the account to be filtered.", + "description": "Whether to list all themes.", "length": 255, - "name": "accountid", - "related": "disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", + "name": "listall", "required": false, - "type": "uuid" + "type": "boolean" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "Whether to only list the default theme.", + "description": "List by keyword", "length": 255, - "name": "listonlydefaulttheme", + "name": "keyword", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "List by keyword", + "description": "Whether to list removed themes.", "length": 255, - "name": "keyword", + "name": "showremoved", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "The ID of the domain to be filtered.", + "description": "The name of the theme.", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "name": "name", "required": false, - "type": "uuid" + "type": "string" }, { "description": "The theme ID.", @@ -52382,9 +52569,17 @@ "type": "uuid" }, { - "description": "Whether to list public themes.", + "description": "The ID of the domain to be filtered.", "length": 255, - "name": "showpublic", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "required": false, + "type": "uuid" + }, + { + "description": "Whether to only list the default theme.", + "length": 255, + "name": "listonlydefaulttheme", "required": false, "type": "boolean" } @@ -52392,35 +52587,36 @@ "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": "Description of the GUI theme.", + "name": "description", "type": "string" }, + {}, { "description": "A set of account UUIDs (also known as ID for the end-user) separated by comma that can retrieve the theme.", "name": "accountids", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "ID of the custom GUI theme.", + "name": "id", + "type": "string" }, { - "description": "Description of the GUI theme.", - "name": "description", - "type": "string" + "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", + "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": "ID of the custom GUI theme.", - "name": "id", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "Name of the GUI theme.", @@ -52433,21 +52629,10 @@ "type": "string" }, { - "description": "When the GUI theme was removed.", - "name": "removed", - "type": "date" - }, - { - "description": "When the GUI theme was created.", - "name": "created", - "type": "date" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "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": "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", @@ -52459,8 +52644,18 @@ "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": "The CSS to be retrieved and imported into the GUI when matching the theme access configurations.", + "name": "css", + "type": "string" + }, + { + "description": "When the GUI theme was created.", + "name": "created", + "type": "date" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ], @@ -52472,151 +52667,145 @@ "name": "updateUser", "params": [ { - "description": "last name", + "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", "length": 255, - "name": "lastname", + "name": "timezone", "required": false, "type": "string" }, { - "description": "Current password that was being used by the user. You must inform the current password when updating the password.", + "description": "Determines if Api key access for this user is enabled, disabled or inherits the value from its parent, the owning account", "length": 255, - "name": "currentpassword", + "name": "apikeyaccess", "required": false, + "since": "4.20.1.0", "type": "string" }, { - "description": "The API key for the user. Must be specified with userSecretKey", + "description": "Unique username", "length": 255, - "name": "userapikey", + "name": "username", "required": false, "type": "string" }, { - "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", + "description": "Current password that was being used by the user. You must inform the current password when updating the password.", "length": 255, - "name": "timezone", + "name": "currentpassword", "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": "Provide true to mandate the user to use two factor authentication has to be enabled.This parameter is only used to mandate 2FA, not to disable 2FA", "length": 255, - "name": "apikeyaccess", + "name": "mandate2fa", "required": false, - "since": "4.20.1.0", - "type": "string" + "since": "4.18.0.0", + "type": "boolean" }, { - "description": "first name", + "description": "email", "length": 255, - "name": "firstname", + "name": "email", "required": false, "type": "string" }, { - "description": "User uuid", + "description": "first name", "length": 255, - "name": "id", - "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", - "required": true, - "type": "uuid" + "name": "firstname", + "required": false, + "type": "string" }, { - "description": "Unique username", + "description": "The secret key for the user. Must be specified with userApiKey", "length": 255, - "name": "username", + "name": "usersecretkey", "required": false, "type": "string" }, { - "description": "email", + "description": "Clear text password (default hashed to SHA256SALT). If you wish to use any other hashing algorithm, you would need to write a custom authentication adapter. Can't be passed when command is executed via integration.api.port", "length": 255, - "name": "email", + "name": "password", "required": false, "type": "string" }, { - "description": "The secret key for the user. Must be specified with userApiKey", + "description": "last name", "length": 255, - "name": "usersecretkey", + "name": "lastname", "required": false, "type": "string" }, { - "description": "Provide true to mandate the user to use two factor authentication has to be enabled.This parameter is only used to mandate 2FA, not to disable 2FA", + "description": "User uuid", "length": 255, - "name": "mandate2fa", - "required": false, - "since": "4.18.0.0", - "type": "boolean" + "name": "id", + "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", + "required": true, + "type": "uuid" }, { - "description": "Clear text password (default hashed to SHA256SALT). If you wish to use any other hashing algorithm, you would need to write a custom authentication adapter. Can't be passed when command is executed via integration.api.port", + "description": "The API key for the user. Must be specified with userSecretKey", "length": 255, - "name": "password", + "name": "userapikey", "required": false, "type": "string" } ], "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser", "response": [ - {}, { - "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 name of the user", - "name": "domain", - "type": "string" + "description": "true if user has two factor authentication enabled", + "name": "is2faenabled", + "type": "boolean" }, { - "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": "the user email address", + "name": "email", + "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 timezone user was created in", - "name": "timezone", + "description": "the user state", + "name": "state", "type": "string" }, { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the domain ID of the user", + "name": "domainid", + "type": "string" }, { - "description": "the user state", - "name": "state", + "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 ID of the role", - "name": "roleid", - "type": "string" + "description": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { "description": "true if user has two factor authentication is mandated", @@ -52624,43 +52813,49 @@ "type": "boolean" }, { - "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": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", + "name": "apikeyaccess", + "type": "apikeyaccess" }, { - "description": "the api key of the user", - "name": "apikey", + "description": "the account ID of the user", + "name": "accountid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the domain name of the user", + "name": "domain", + "type": "string" }, { - "description": "the user lastname", - "name": "lastname", + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { - "description": "the type of the role", - "name": "roletype", + "description": "the user ID", + "name": "id", "type": "string" }, { - "description": "the domain ID of the user", - "name": "domainid", + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" + }, + {}, + { + "description": "the type of the role", + "name": "roletype", "type": "string" }, { - "description": "the account ID of the user", - "name": "accountid", + "description": "the account name of the user", + "name": "account", "type": "string" }, { @@ -52669,34 +52864,34 @@ "type": "string" }, { - "description": "the user email address", - "name": "email", + "description": "the timezone user was created in", + "name": "timezone", "type": "string" }, { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "true if user has two factor authentication enabled", - "name": "is2faenabled", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", + "description": "the api key of the user", + "name": "apikey", "type": "string" }, { - "description": "the name of the role", - "name": "rolename", + "description": "the user lastname", + "name": "lastname", "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" } ] }, @@ -52709,23 +52904,12 @@ "description": "the ID of the load balancer rule", "length": 255, "name": "lbruleid", - "related": "createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,updateIpv6FirewallRule", + "related": "createRoutingFirewallRule,listRoutingFirewallRules,updateIpv6FirewallRule,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule", "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", @@ -52736,6 +52920,17 @@ "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" } ] }, @@ -52744,6 +52939,14 @@ "isasync": false, "name": "addHost", "params": [ + { + "description": "the Pod ID for the host", + "length": 255, + "name": "podid", + "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", + "required": true, + "type": "uuid" + }, { "description": "hypervisor type of the host", "length": 255, @@ -52751,6 +52954,27 @@ "required": true, "type": "string" }, + { + "description": "Allocation state of this Host for allocation of new resources", + "length": 255, + "name": "allocationstate", + "required": false, + "type": "string" + }, + { + "description": "the username for the host; required to be passed for hypervisors other than VMWare", + "length": 255, + "name": "username", + "required": false, + "type": "string" + }, + { + "description": "the cluster name for the host", + "length": 255, + "name": "clustername", + "required": false, + "type": "string" + }, { "description": "comma separated list of storage access groups for the host", "length": 255, @@ -52760,9 +52984,9 @@ "type": "list" }, { - "description": "the cluster name for the host", + "description": "the password for the host; required to be passed for hypervisors other than VMWare", "length": 255, - "name": "clustername", + "name": "password", "required": false, "type": "string" }, @@ -52773,14 +52997,6 @@ "required": false, "type": "list" }, - { - "description": "the Pod ID for the host", - "length": 255, - "name": "podid", - "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", - "required": true, - "type": "uuid" - }, { "description": "Details in key/value pairs using format externaldetails[i].keyname=keyvalue. Example: externaldetails[0].endpoint.url=urlvalue", "length": 255, @@ -52790,10 +53006,10 @@ "type": "map" }, { - "description": "Allocation state of this Host for allocation of new resources", + "description": "the host URL", "length": 255, - "name": "allocationstate", - "required": false, + "name": "url", + "required": true, "type": "string" }, { @@ -52811,196 +53027,129 @@ "related": "createZone,listZones,listZones", "required": true, "type": "uuid" - }, - { - "description": "the username for the host; required to be passed for hypervisors other than VMWare", - "length": 255, - "name": "username", - "required": false, - "type": "string" - }, - { - "description": "the host URL", - "length": 255, - "name": "url", - "required": true, - "type": "string" - }, - { - "description": "the password for the host; required to be passed for hypervisors other than VMWare", - "length": 255, - "name": "password", - "required": false, - "type": "string" } ], - "related": "cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost,addBaremetalHost", + "related": "addBaremetalHost,cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost", "response": [ { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", - "type": "string" - }, - {}, - { - "description": "the host hypervisor", - "name": "hypervisor", - "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": "the number of CPU sockets on the host", - "name": "cpusockets", + "description": "the CPU number of the host", + "name": "cpunumber", "type": "integer" }, { - "description": "comma-separated list of storage access groups for the host", - "name": "storageaccessgroups", + "description": "the cluster ID of the host", + "name": "clusterid", "type": "string" }, { - "description": "the virtual machine id for host type ConsoleProxy and SecondaryStorageVM", - "name": "virtualmachineid", + "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", "type": "string" }, { - "description": "the date and time the host was last pinged", - "name": "lastpinged", - "type": "date" - }, - { - "description": "the amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", + "description": "the management server ID of the host", + "name": "managementserverid", "type": "string" }, { - "description": "Total GPUs on the Host", - "name": "gputotal", + "description": "the CPU speed of the host", + "name": "cpuspeed", "type": "long" }, - { - "description": "true if the host supports instance conversion (using virt-v2v)", - "name": "instanceconversionsupported", - "type": "boolean" - }, - { - "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", - "type": "string" - }, - { - "description": "the ID of the host", - "name": "id", - "type": "string" - }, - { - "description": "the IP address of the host", - "name": "ipaddress", - "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": "the amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", "type": "string" }, { - "description": "comma-separated list of storage access groups on the pod", - "name": "podstorageaccessgroups", + "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 Zone ID of the host", + "name": "zoneid", "type": "string" }, { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", + "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": "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 amount of the host's CPU currently allocated in MHz", - "name": "cpuallocatedvalue", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", + "description": "the admin that annotated this host", + "name": "username", "type": "string" }, { - "description": "true if the host is disconnected. False otherwise.", - "name": "disconnected", - "type": "date" + "description": "true if the host supports encryption", + "name": "encryptionsupported", + "type": "boolean" }, { - "description": "the hypervisor version", - "name": "hypervisorversion", + "description": "events available for the host", + "name": "events", "type": "string" }, { - "description": "the cluster name of the host", - "name": "clustername", - "type": "string" + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" }, { - "description": "true if the host supports encryption", - "name": "encryptionsupported", + "description": "true if the host has capability to support UEFI boot", + "name": "ueficapability", "type": "boolean" }, { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", + "description": "Used GPUs on the Host", + "name": "gpuused", "type": "long" }, - {}, { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", + "description": "the resource state of the host", + "name": "resourcestate", "type": "string" }, { - "description": "the last time this host was annotated", - "name": "lastannotated", - "type": "date" + "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 state of the host", + "name": "state", + "type": "status" }, { - "description": "the Zone name of the host", - "name": "zonename", + "description": "comma-separated list of explicit host tags for the host", + "name": "explicithosttags", "type": "string" }, { @@ -53009,34 +53158,68 @@ "type": "string" }, { - "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 admin that annotated this host", - "name": "username", + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", "type": "string" }, { - "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": "GPU cards present in the host", + "name": "gpugroup", + "response": [ + { + "description": "the list of enabled vGPUs", + "name": "vgpu", + "response": [ + { + "description": "Model Name of vGPU", + "name": "vgputype", + "type": "string" + }, + { + "description": "Maximum Y resolution per display", + "name": "maxresolutiony", + "type": "long" + }, + { + "description": "Maximum displays per user", + "name": "maxheads", + "type": "long" + }, + { + "description": "Maximum X resolution per display", + "name": "maxresolutionx", + "type": "long" + }, + { + "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", + "name": "maxcapacity", + "type": "long" + }, + { + "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", + "name": "remainingcapacity", + "type": "long" + }, + { + "description": "Video RAM for this vGPU type", + "name": "videoram", + "type": "long" + }, + { + "description": "Maximum no. of vgpu per gpu card (pgpu)", + "name": "maxvgpuperpgpu", + "type": "long" + } + ], + "type": "list" + }, + { + "description": "GPU cards present in the host", + "name": "gpugroupname", + "type": "string" + } + ], + "type": "list" }, { "description": "comma-separated list of tags for the host", @@ -53044,44 +53227,29 @@ "type": "string" }, { - "description": "the Zone ID of the host", - "name": "zoneid", - "type": "string" - }, - { - "description": "the Pod name of the host", - "name": "podname", + "description": "comma-separated list of implicit host tags for the host", + "name": "implicithosttags", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if 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 OS category name of the host", - "name": "oscategoryname", - "type": "string" - }, - { - "description": "the date and time the host was created", - "name": "created", - "type": "date" - }, - { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "the host type", + "name": "type", + "type": "type" }, { - "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", + "description": "the virtual machine id for host type ConsoleProxy and SecondaryStorageVM", + "name": "virtualmachineid", "type": "string" }, { - "description": "the CPU number of the host", - "name": "cpunumber", - "type": "integer" + "description": "the cpu average load on the host", + "name": "cpuloadaverage", + "type": "double" }, { "description": "the name of the host", @@ -53089,34 +53257,14 @@ "type": "string" }, { - "description": "the CPU speed of the host", - "name": "cpuspeed", + "description": "the amount of the host's memory currently allocated in bytes", + "name": "memoryallocatedbytes", "type": "long" }, { - "description": "the state of the host", - "name": "state", - "type": "status" - }, - { - "description": "the host version", - "name": "version", - "type": "string" - }, - { - "description": "the host HA information information", - "name": "hostha", - "type": "hostharesponse" - }, - { - "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", - "name": "suitableformigration", - "type": "boolean" - }, - { - "description": "the last annotation set on this host by an admin", - "name": "annotation", - "type": "string" + "description": "Total GPUs on the Host", + "name": "gputotal", + "type": "long" }, { "description": "The ID of extension for this cluster", @@ -53124,104 +53272,41 @@ "type": "string" }, { - "description": "capabilities of the host", - "name": "capabilities", - "type": "string" + "description": "true if the host supports instance conversion (using virt-v2v)", + "name": "instanceconversionsupported", + "type": "boolean" }, { - "description": "the OS category ID of the host", - "name": "oscategoryid", - "type": "string" + "description": "Host details in key/value pairs.", + "name": "details", + "type": "map" }, + {}, { - "description": "the host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" + "description": "the date and time the host was created", + "name": "created", + "type": "date" }, { - "description": "comma-separated list of storage access groups on the cluster", - "name": "clusterstorageaccessgroups", + "description": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", "type": "string" }, { - "description": "the cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" - }, - { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", "type": "long" }, { - "description": "comma-separated list of implicit host tags for the host", - "name": "implicithosttags", - "type": "string" - }, - { - "description": "the Pod ID of the host", - "name": "podid", + "description": "the Pod name of the host", + "name": "podname", "type": "string" }, {}, { - "description": "GPU cards present in the host", - "name": "gpugroup", - "response": [ - { - "description": "the list of enabled vGPUs", - "name": "vgpu", - "response": [ - { - "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", - "name": "remainingcapacity", - "type": "long" - }, - { - "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", - "name": "maxcapacity", - "type": "long" - }, - { - "description": "Video RAM for this vGPU type", - "name": "videoram", - "type": "long" - }, - { - "description": "Maximum Y resolution per display", - "name": "maxresolutiony", - "type": "long" - }, - { - "description": "Model Name of vGPU", - "name": "vgputype", - "type": "string" - }, - { - "description": "Maximum X resolution per display", - "name": "maxresolutionx", - "type": "long" - }, - { - "description": "Maximum no. of vgpu per gpu card (pgpu)", - "name": "maxvgpuperpgpu", - "type": "long" - }, - { - "description": "Maximum displays per user", - "name": "maxheads", - "type": "long" - } - ], - "type": "list" - }, - { - "description": "GPU cards present in the host", - "name": "gpugroupname", - "type": "string" - } - ], - "type": "list" + "description": "the Zone name of the host", + "name": "zonename", + "type": "string" }, { "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", @@ -53229,187 +53314,201 @@ "type": "string" }, { - "description": "Used GPUs on the Host", - "name": "gpuused", - "type": "long" + "description": "the date and time the host was last pinged", + "name": "lastpinged", + "type": "date" }, { - "description": "the cluster ID of the host", - "name": "clusterid", + "description": "the IP address of the host", + "name": "ipaddress", "type": "string" }, { - "description": "true if the host has capability to support UEFI boot", - "name": "ueficapability", - "type": "boolean" + "description": "the OS category ID of the host", + "name": "oscategoryid", + "type": "string" }, { - "description": "the host type", - "name": "type", - "type": "type" + "description": "the host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" }, { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", + "description": "the host version", + "name": "version", + "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 percentage", - "name": "cpuallocatedpercentage", + "description": "comma-separated list of storage access groups on the pod", + "name": "podstorageaccessgroups", "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", + "type": "long" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", + "description": "the incoming network traffic on the host", + "name": "networkkbsread", "type": "long" }, { - "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 name of extension for this cluster", - "name": "extensionname", + "description": "the last annotation set on this host by an admin", + "name": "annotation", "type": "string" - } - ] - }, - { - "description": "Attaches a disk volume to a virtual machine.", - "isasync": true, - "name": "attachVolume", - "params": [ - { - "description": "The ID of the device to map the volume to the guest OS. If no deviceID is informed, the next available deviceID will be chosen. Use 0 when volume needs to be attached as ROOT.
When using a linux operating system and the hypervisor XenServer, the devices IDs will be mapped as follows:
  • 0 maps to /dev/xvda;
  • 1 maps to /dev/xvdb;
  • 2 maps /dev/xvdc and so on.
Please refer to the docs of your hypervisor for the correct mapping of the deviceID and the actual logical disk structure.", - "length": 255, - "name": "deviceid", - "required": false, - "type": "long" }, { - "description": " the ID of the virtual machine", - "length": 255, - "name": "virtualmachineid", - "related": "assignVirtualMachine,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", - "required": true, - "type": "uuid" + "description": "The name of extension for this cluster", + "name": "extensionname", + "type": "string" }, { - "description": "the ID of the disk volume", - "length": 255, - "name": "id", - "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", - "required": true, - "type": "uuid" - } - ], - "related": "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", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", + "description": "the date and time the host was removed", + "name": "removed", "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": "the hypervisor version", + "name": "hypervisorversion", "type": "string" }, { - "description": "size of the disk volume", - "name": "size", + "description": "the amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", "type": "long" }, { - "description": "state of the virtual machine", - "name": "vmstate", - "type": "string" + "description": "the last time this host was annotated", + "name": "lastannotated", + "type": "date" }, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", + "description": "CPU Arch of the host", + "name": "arch", "type": "string" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": "the ID of the host", + "name": "id", "type": "string" }, { - "description": "the state of the disk volume", - "name": "state", - "type": "string" + "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "name": "memorytotal", + "type": "long" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "the Pod ID of the host", + "name": "podid", "type": "string" }, - {}, { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "the amount of the host's memory currently used", + "name": "memoryused", + "type": "long" + }, + { + "description": "capabilities of the host", + "name": "capabilities", "type": "string" }, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "the cluster name of the host", + "name": "clustername", "type": "string" }, { - "description": "details for the volume check result, they may vary for different hypervisors", - "name": "volumecheckresult", - "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": "ID of the disk volume", - "name": "id", + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", "type": "string" }, { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", - "type": "boolean" + "description": "the number of CPU sockets on the host", + "name": "cpusockets", + "type": "integer" }, { - "description": "the disk utilization", - "name": "utilization", + "description": "the host hypervisor", + "name": "hypervisor", "type": "string" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", - "type": "boolean" + "description": "the OS category name of the host", + "name": "oscategoryname", + "type": "string" }, { - "description": "the format of the disk encryption if applicable", - "name": "encryptformat", + "description": "the cluster type of the cluster that host belongs to", + "name": "clustertype", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the management server name of the host", + "name": "managementservername", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "comma-separated list of storage access groups on the cluster", + "name": "clusterstorageaccessgroups", "type": "string" + } + ] + }, + { + "description": "Attaches a disk volume to a virtual machine.", + "isasync": true, + "name": "attachVolume", + "params": [ + { + "description": "the ID of the disk volume", + "length": 255, + "name": "id", + "related": "importVolume,attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", + "required": true, + "type": "uuid" }, { - "description": "the account associated with the disk volume", - "name": "account", + "description": " the ID of the virtual machine", + "length": 255, + "name": "virtualmachineid", + "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,createVMFromBackup,createVMFromBackup,assignVirtualMachine,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", + "required": true, + "type": "uuid" + }, + { + "description": "The ID of the device to map the volume to the guest OS. If no deviceID is informed, the next available deviceID will be chosen. Use 0 when volume needs to be attached as ROOT.
When using a linux operating system and the hypervisor XenServer, the devices IDs will be mapped as follows:
  • 0 maps to /dev/xvda;
  • 1 maps to /dev/xvdb;
  • 2 maps /dev/xvdc and so on.
Please refer to the docs of your hypervisor for the correct mapping of the deviceID and the actual logical disk structure.", + "length": 255, + "name": "deviceid", + "required": false, + "type": "long" + } + ], + "related": "importVolume,createVolume,updateVolume,listVolumes,migrateVolume,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", + "response": [ + { + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { @@ -53418,82 +53517,107 @@ "type": "string" }, { - "description": "the chain info of the volume", - "name": "chaininfo", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "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": "type of the virtual machine", - "name": "vmtype", + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the disk utilization", + "name": "utilization", "type": "string" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", + "description": "min iops of the disk volume", + "name": "miniops", "type": "long" }, { - "description": "shared or local storage", - "name": "storagetype", + "description": "details for the volume check result, they may vary for different hypervisors", + "name": "volumecheckresult", + "type": "map" + }, + { + "description": "pod id of the volume", + "name": "podid", "type": "string" }, { - "description": "the path of the volume", - "name": "path", + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", "type": "string" }, { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", + "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": "pod name of the volume", - "name": "podname", + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, + { + "description": "the date the disk volume was created", + "name": "created", + "type": "date" + }, + { + "description": "the bytes actually consumed on disk", + "name": "physicalsize", + "type": "long" + }, { "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 display text of the disk offering", + "name": "diskofferingdisplaytext", + "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": "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" + }, + { + "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": "customer associated with the tag", - "name": "customer", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -53507,13 +53631,18 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -53527,46 +53656,41 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "resource type", + "name": "resourcetype", "type": "string" } ], "type": "set" }, { - "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": "type of the virtual machine", + "name": "vmtype", + "type": "string" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "state of the virtual machine", + "name": "vmstate", "type": "string" }, { - "description": "name of the virtual machine", - "name": "vmname", + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { @@ -53575,84 +53699,103 @@ "type": "long" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "description": "ID of the disk volume", + "name": "id", "type": "string" }, { - "description": "the bytes actually consumed on disk", - "name": "physicalsize", + "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", + "description": "the chain info of the volume", + "name": "chaininfo", "type": "string" }, { - "description": "name of the disk volume", - "name": "name", - "type": "string" + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" }, { - "description": "the status of the volume", - "name": "status", + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "max iops of the disk volume", - "name": "maxiops", - "type": "long" + "description": "details for the volume repair result, they may vary for different hypervisors", + "name": "volumerepairresult", + "type": "map" }, { - "description": "the bytes allocated", - "name": "virtualsize", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, - {}, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", - "type": "boolean" + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", + "type": "string" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "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 write (IO) of disk on the vm", - "name": "diskiowrite", + "description": "size of the disk volume", + "name": "size", "type": "long" }, + { + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", + "type": "boolean" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" + "description": "the path of the volume", + "name": "path", + "type": "string" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "type": "long" + }, + { + "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": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "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", + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", "type": "boolean" }, { @@ -53661,18 +53804,13 @@ "type": "string" }, { - "description": "cluster id of the volume", - "name": "clusterid", - "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": "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" }, { @@ -53681,59 +53819,116 @@ "type": "string" }, { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "cluster name where the volume is allocated", + "name": "clustername", "type": "string" }, { - "description": "pod id of the volume", - "name": "podid", + "description": "name of the disk volume", + "name": "name", "type": "string" }, { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", + "description": "the account associated with the disk volume", + "name": "account", + "type": "string" + }, + { + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", "type": "boolean" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", "type": "string" }, { - "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", - "name": "deviceid", - "type": "long" + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", + "type": "string" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", + "description": "display name of the virtual machine", + "name": "vmdisplayname", "type": "string" }, + {}, { - "description": "path of the Domain the disk volume belongs to", - "name": "domainpath", + "description": "the state of the disk volume", + "name": "state", "type": "string" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "the status of the volume", + "name": "status", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "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", - "name": "diskIopsWriteRate", + "description": "the format of the disk encryption if applicable", + "name": "encryptformat", + "type": "string" + }, + { + "description": "name of the virtual machine", + "name": "vmname", + "type": "string" + }, + { + "description": "cluster id of the volume", + "name": "clusterid", + "type": "string" + }, + { + "description": "shared or local storage", + "name": "storagetype", + "type": "string" + }, + { + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", + "type": "string" + }, + { + "description": "the bytes allocated", + "name": "virtualsize", "type": "long" }, { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", + "description": "the project id of the vpn", + "name": "projectid", + "type": "string" + }, + { + "description": "max iops of the disk volume", + "name": "maxiops", + "type": "long" + }, + {}, + { + "description": "name of the service offering for root disk", + "name": "serviceofferingname", + "type": "string" + }, + { + "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": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" } ] }, @@ -53750,6 +53945,14 @@ "required": false, "type": "uuid" }, + { + "description": "an optional project for the userdata", + "length": 255, + "name": "projectid", + "related": "activateProject,createProject,suspendProject,updateProject", + "required": false, + "type": "uuid" + }, { "description": "an optional account for the userdata. Must be used with domainId.", "length": 255, @@ -53764,39 +53967,31 @@ "related": "listCniConfiguration", "required": true, "type": "uuid" - }, - { - "description": "an optional project for the userdata", - "length": 255, - "name": "projectid", - "related": "activateProject,createProject,suspendProject,updateProject", - "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": "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.21.0" }, @@ -53806,48 +54001,48 @@ "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" }, { - "description": "name of the project", + "description": "display text of the project", "length": 255, - "name": "name", + "name": "displaytext", "required": false, - "since": "4.19.0", "type": "string" }, { - "description": "ID of the user to be promoted/demoted", + "description": "id of the project to be modified", "length": 255, - "name": "userid", - "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser", - "required": false, + "name": "id", + "related": "activateProject,createProject,suspendProject,updateProject", + "required": true, "type": "uuid" }, { - "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" }, { - "description": "display text of the project", + "description": "Account level role to be assigned to the user/account : Admin/Regular", "length": 255, - "name": "displaytext", + "name": "roletype", "required": false, "type": "string" }, { - "description": "new Admin account for the project", + "description": "name of the project", "length": 255, - "name": "account", + "name": "name", "required": false, + "since": "4.19.0", "type": "string" }, { @@ -53860,28 +54055,68 @@ ], "related": "activateProject,createProject,suspendProject", "response": [ + { + "description": "the total number of gpus owned by project", + "name": "gputotal", + "type": "long" + }, + { + "description": "the total number of networks available to be created for this project", + "name": "networkavailable", + "type": "string" + }, + { + "description": "the domain id the project belongs to", + "name": "domainid", + "type": "string" + }, + { + "description": "the total number of templates available to be created by this project", + "name": "templateavailable", + "type": "string" + }, + { + "description": "the total memory (in MB) the project can own", + "name": "memorylimit", + "type": "string" + }, + { + "description": "the total number of backups available to this project", + "name": "backupavailable", + "type": "string" + }, + { + "description": "the total number of snapshots stored by this project", + "name": "snapshottotal", + "type": "long" + }, { "description": "the list of resource tags associated with vm", "name": "tags", "response": [ + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, { "description": "the account associated with the tag", "name": "account", "type": "string" }, { - "description": "tag key name", - "name": "key", + "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": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -53889,72 +54124,57 @@ "name": "resourcetype", "type": "string" }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, { "description": "the domain associated with the tag", "name": "domain", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "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": "tag value", - "name": "value", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "list" }, { - "description": "the total number of networks available to be created for this project", - "name": "networkavailable", + "description": "the total number of networks the project can own", + "name": "networklimit", "type": "string" }, { - "description": "the total number of vpcs owned by project", - "name": "vpctotal", + "description": "the total number of networks owned by project", + "name": "networktotal", "type": "long" }, { - "description": "the total number of buckets available to this project", - "name": "bucketavailable", - "type": "string" - }, - { - "description": "the total number of gpus available to be created for this project", - "name": "gpuavailable", - "type": "string" - }, - { - "description": "The tagged resource limit and count for the project", - "name": "taggedresources", - "type": "list" + "description": "the 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", - "name": "primarystorageavailable", + "description": "the total number of virtual machines that can be deployed by this project", + "name": "vmlimit", "type": "string" }, { - "description": "the name of the project", - "name": "name", + "description": "the total number of public ip addresses available for this project to acquire", + "name": "ipavailable", "type": "string" }, { @@ -53963,99 +54183,99 @@ "type": "string" }, { - "description": "the total number of backups stored by this project", - "name": "backuptotal", - "type": "long" + "description": "the name of the project", + "name": "name", + "type": "string" }, { - "description": "the total secondary storage space (in GiB) available to be used for this project", - "name": "secondarystorageavailable", + "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", + "description": "the total number of vpcs the project can own", + "name": "vpclimit", "type": "string" }, { - "description": "the total number of virtual machines running for this project", - "name": "vmrunning", + "description": "the total number of virtual machines stopped for this project", + "name": "vmstopped", "type": "integer" }, { - "description": "the total number of networks owned by project", - "name": "networktotal", - "type": "long" + "description": "the id of the project", + "name": "id", + "type": "string" }, { - "description": "the total number of virtual machines that can be deployed by this project", - "name": "vmlimit", + "description": "the total number of gpus available to be created for this project", + "name": "gpuavailable", "type": "string" }, { - "description": "the total object storage space (in GiB) available to the project", - "name": "objectstorageavailable", + "description": "the total number of templates which can be created by this project", + "name": "templatelimit", "type": "string" }, { - "description": "the total primary storage space (in GiB) the project can own", - "name": "primarystoragelimit", + "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 allocated for this project", - "name": "iptotal", + "description": "the total number of vpcs owned by project", + "name": "vpctotal", "type": "long" }, { - "description": "the total volume which can be used by this project", - "name": "volumelimit", - "type": "string" + "description": "the total volume being used by this project", + "name": "volumetotal", + "type": "long" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the total number of virtual machines available for this project to acquire", + "name": "vmavailable", + "type": "string" }, { - "description": "the total number of public ip addresses this project can acquire", - "name": "iplimit", + "description": "the total object storage space (in GiB) available to the project", + "name": "objectstorageavailable", "type": "string" }, { - "description": "the state of the project", - "name": "state", - "type": "string" + "description": "the total secondary storage space (in GiB) owned by project", + "name": "secondarystoragetotal", + "type": "float" }, { - "description": "the total number of buckets stored by this project", - "name": "buckettotal", - "type": "long" + "description": "the total object storage space (in GiB) the project can own", + "name": "objectstoragelimit", + "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by project", - "name": "primarystoragetotal", + "description": "the total memory (in MB) owned by project", + "name": "memorytotal", "type": "long" }, { - "description": "the total backup storage space (in GiB) available to the project", - "name": "backupstorageavailable", + "description": "the total number of buckets available to this project", + "name": "bucketavailable", "type": "string" }, { - "description": "the total number of networks the project can own", - "name": "networklimit", + "description": "the total volume which can be used by this project", + "name": "volumelimit", "type": "string" }, { - "description": "the id of the project", - "name": "id", + "description": "the total number of vpcs available to be created for this project", + "name": "vpcavailable", "type": "string" }, { - "description": "the displaytext of the project", - "name": "displaytext", - "type": "string" + "description": "the total number of virtual machines running for this project", + "name": "vmrunning", + "type": "integer" }, { "description": "the total number of backups which can be stored by this project", @@ -54063,65 +54283,44 @@ "type": "string" }, { - "description": "the total backup storage space (in GiB) owned by the project", - "name": "backupstoragetotal", - "type": "long" - }, - {}, - { - "description": "the account name of the project's owners", - "name": "owner", - "type": "list" - }, - { - "description": "the total number of cpu cores owned by project", - "name": "cputotal", - "type": "long" - }, - { - "description": "the total number of vpcs available to be created for this project", - "name": "vpcavailable", - "type": "string" - }, - { - "description": "the total number of virtual machines available for this project 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 vpcs the project can own", - "name": "vpclimit", - "type": "string" + "description": "the total object storage space (in GiB) owned by the project", + "name": "objectstoragetotal", + "type": "long" }, { - "description": "the total number of snapshots stored by this project", - "name": "snapshottotal", + "description": "the total number of templates which have been created by this project", + "name": "templatetotal", "type": "long" }, { - "description": "the total number of templates which can be created by this project", - "name": "templatelimit", + "description": "the total number of snapshots which can be stored by this project", + "name": "snapshotlimit", "type": "string" }, { - "description": "the total number of public ip addresses available for this project to acquire", - "name": "ipavailable", + "description": "the total number of gpus the project can own", + "name": "gpulimit", "type": "string" }, { - "description": "the total object storage space (in GiB) the project can own", - "name": "objectstoragelimit", + "description": "the total secondary storage space (in GiB) the project can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "the total number of gpus owned by project", - "name": "gputotal", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the total volume being used by this project", - "name": "volumetotal", - "type": "long" + "description": "the total number of cpu cores the project can own", + "name": "cpulimit", + "type": "string" }, { "description": "the project account name of the project", @@ -54129,8 +54328,8 @@ "type": "string" }, { - "description": "the total object storage space (in GiB) owned by the project", - "name": "objectstoragetotal", + "description": "the total number of virtual machines deployed by this project", + "name": "vmtotal", "type": "long" }, { @@ -54138,106 +54337,102 @@ "name": "bucketlimit", "type": "string" }, + {}, { - "description": "the total number of cpu cores the project can own", - "name": "cpulimit", + "description": "the total number of cpu cores available to be created for this project", + "name": "cpuavailable", "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 total memory (in MB) available to be created for this project", - "name": "memoryavailable", + "description": "the total volume available for this project", + "name": "volumeavailable", "type": "string" }, - {}, { "description": "the total number of snapshots available for this project", "name": "snapshotavailable", "type": "string" }, { - "description": "the total number of gpus the project can own", - "name": "gpulimit", + "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", + "description": "the total number of cpu cores owned by project", + "name": "cputotal", "type": "long" }, { - "description": "the domain id the project belongs to", - "name": "domainid", - "type": "string" + "description": "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 total number of buckets stored by this project", + "name": "buckettotal", + "type": "long" }, { - "description": "the total memory (in MB) owned by project", - "name": "memorytotal", + "description": "the total number of public ip addresses allocated for this project", + "name": "iptotal", "type": "long" }, { - "description": "the total secondary storage space (in GiB) the project can own", - "name": "secondarystoragelimit", + "description": "the total backup storage space (in GiB) available to the project", + "name": "backupstorageavailable", "type": "string" }, { - "description": "the total volume available for this project", - "name": "volumeavailable", - "type": "string" + "description": "the account name of the project's owners", + "name": "owner", + "type": "list" }, { - "description": "the total number of templates available to be created by this project", - "name": "templateavailable", + "description": "the total secondary storage space (in GiB) available to be used for this project", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "the total memory (in MB) the project can own", - "name": "memorylimit", + "description": "the total primary storage space (in GiB) available to be used for this project", + "name": "primarystorageavailable", "type": "string" }, { - "description": "the total number of cpu cores available to be created for this project", - "name": "cpuavailable", + "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 project", - "name": "secondarystoragetotal", - "type": "float" - }, - { - "description": "the total number of snapshots which can be stored by this project", - "name": "snapshotlimit", + "description": "the displaytext of the project", + "name": "displaytext", "type": "string" }, { - "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 project", + "name": "backuptotal", + "type": "long" }, { - "description": "the total number of virtual machines deployed by this project", - "name": "vmtotal", + "description": "the total backup storage space (in GiB) owned by the project", + "name": "backupstoragetotal", "type": "long" }, { - "description": "the total number of virtual machines stopped for this project", - "name": "vmstopped", - "type": "integer" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the state of the project", + "name": "state", + "type": "string" } ], "since": "3.0.0" @@ -54248,84 +54443,75 @@ "name": "listLoadBalancers", "params": [ { - "description": "the ID of the load balancer", + "description": "the network ID of the source IP address", "length": 255, - "name": "id", - "related": "createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,updateIpv6FirewallRule", + "name": "sourceipaddressnetworkid", + "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, "type": "uuid" }, { - "description": "the source IP address of the load balancer", - "length": 255, - "name": "sourceipaddress", - "required": false, - "type": "string" - }, - { - "description": "the scheme of the load balancer. Supported value is internal in the current release", + "description": "the network ID of the load balancer", "length": 255, - "name": "scheme", + "name": "networkid", + "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "List by keyword", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "keyword", + "name": "tags", "required": false, - "type": "string" + "type": "map" }, { - "description": "List resources by tags (key/value pairs)", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "tags", + "name": "listall", "required": false, - "type": "map" + "type": "boolean" }, { - "description": "list only resources belonging to the domain specified", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the network ID of the source IP address", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "sourceipaddressnetworkid", - "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "isrecursive", "required": false, - "type": "uuid" + "type": "boolean" }, { - "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": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "the scheme of the load balancer. Supported value is internal in the current release", "length": 255, - "name": "fordisplay", + "name": "scheme", "required": false, - "since": "4.4", - "type": "boolean" + "type": "string" }, { - "description": "the network ID of the load balancer", + "description": "the ID of the load balancer", "length": 255, - "name": "networkid", - "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "id", + "related": "createRoutingFirewallRule,listRoutingFirewallRules,updateIpv6FirewallRule,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule", "required": false, "type": "uuid" }, @@ -54337,31 +54523,40 @@ "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": "activateProject,createProject,suspendProject", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "projectid", - "related": "activateProject,createProject,suspendProject", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,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": "", "length": 255, - "name": "isrecursive", + "name": "page", + "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 name of the load balancer", + "description": "the source IP address of the load balancer", "length": 255, - "name": "name", + "name": "sourceipaddress", "required": false, "type": "string" } @@ -54369,18 +54564,45 @@ "related": "createLoadBalancer", "response": [ { - "description": "Load Balancer network id", - "name": "networkid", + "description": "the project id of the Load Balancer", + "name": "projectid", "type": "string" }, { - "description": "the name of the Load Balancer", - "name": "name", + "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 instance ID", + "name": "id", + "type": "string" + }, + { + "description": "the state of the instance", + "name": "state", + "type": "string" + }, + { + "description": "the name of the instance", + "name": "name", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Load Balancer source ip network id", - "name": "sourceipaddressnetworkid", + "description": "the account of the Load Balancer", + "name": "account", "type": "string" }, { @@ -54388,10 +54610,19 @@ "name": "domainid", "type": "string" }, - {}, { - "description": "the load balancer algorithm (source, roundrobin, leastconn)", - "name": "algorithm", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the project name of the Load Balancer", + "name": "project", + "type": "string" + }, + { + "description": "path of the domain to which the Load Balancer belongs", + "name": "domainpath", "type": "string" }, { @@ -54400,47 +54631,54 @@ "type": "string" }, { - "description": "the project id of the Load Balancer", - "name": "projectid", + "description": "the Load Balancer ID", + "name": "id", "type": "string" }, { - "description": "the list of resource tags associated with the Load Balancer", - "name": "tags", + "description": "Load Balancer network id", + "name": "networkid", + "type": "string" + }, + { + "description": "the list of rules associated with the Load Balancer", + "name": "loadbalancerrule", "response": [ { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", + "description": "the state of the load balancer rule", + "name": "state", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", - "type": "string" + "description": "source port of the load balancer rule", + "name": "sourceport", + "type": "integer" }, { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, + "description": "instance port of the load balancer rule", + "name": "instanceport", + "type": "integer" + } + ], + "type": "list" + }, + { + "description": "the list of resource tags associated with the Load Balancer", + "name": "tags", + "response": [ { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "tag 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" }, { @@ -54449,118 +54687,75 @@ "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": "tag value", + "name": "value", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "id of the resource", + "name": "resourceid", "type": "string" - } - ], - "type": "list" - }, - {}, - { - "description": "the list of instances associated with the Load Balancer", - "name": "loadbalancerinstance", - "response": [ + }, { - "description": "the state of the instance", - "name": "state", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the instance ID", - "name": "id", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the ip address of the instance", - "name": "ipaddress", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the name of the instance", - "name": "name", + "description": "the account associated with the tag", + "name": "account", "type": "string" } ], "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": "the name of the Load Balancer", + "name": "name", "type": "string" }, - { - "description": "the list of rules associated with the Load Balancer", - "name": "loadbalancerrule", - "response": [ - { - "description": "instance port of the load balancer rule", - "name": "instanceport", - "type": "integer" - }, - { - "description": "source port of the load balancer rule", - "name": "sourceport", - "type": "integer" - }, - { - "description": "the state of the load balancer rule", - "name": "state", - "type": "string" - } - ], - "type": "list" - }, { "description": "the description of the Load Balancer", "name": "description", "type": "string" }, { - "description": "the account of the Load Balancer", - "name": "account", + "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": "Load Balancer source ip network id", + "name": "sourceipaddressnetworkid", + "type": "string" }, { - "description": "the Load Balancer ID", - "name": "id", - "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", + "description": "the domain of the Load Balancer", + "name": "domain", "type": "string" - } + }, + {} ], "since": "4.2.0" }, @@ -54580,22 +54775,16 @@ ], "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", + "description": "the api key of the registered user", + "name": "apikey", "type": "string" }, - {}, { "description": "whether api key access is allowed or not", "name": "apikeyaccess", @@ -54606,7 +54795,13 @@ "name": "jobstatus", "type": "integer" }, - {} + {}, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } ] }, { @@ -54629,23 +54824,23 @@ "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": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } ], "since": "3.0.0" }, @@ -54654,6 +54849,13 @@ "isasync": false, "name": "listVpnConnections", "params": [ + { + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, { "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, @@ -54662,27 +54864,26 @@ "type": "boolean" }, { - "description": "list only resources belonging to the domain specified", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "name": "isrecursive", "required": false, - "type": "uuid" + "type": "boolean" }, { - "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": "", @@ -54692,73 +54893,56 @@ "type": "integer" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "id of vpc", "length": 255, - "name": "projectid", - "related": "activateProject,createProject,suspendProject", + "name": "vpcid", + "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", "required": false, "type": "uuid" }, { - "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" }, { - "description": "id of the vpn connection", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "id", - "related": "createVpnConnection,listVpnConnections,updateVpnConnection", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, "type": "uuid" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", - "length": 255, - "name": "isrecursive", - "required": false, - "type": "boolean" - }, - { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "id of the vpn connection", "length": 255, - "name": "fordisplay", + "name": "id", + "related": "createVpnConnection,listVpnConnections,updateVpnConnection", "required": false, - "since": "4.4", - "type": "boolean" + "type": "uuid" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" } ], "related": "createVpnConnection,updateVpnConnection", "response": [ - { - "description": "ESP policy of the customer gateway", - "name": "esppolicy", - "type": "string" - }, - { - "description": "the customer gateway ID", - "name": "s2scustomergatewayid", - "type": "string" - }, { "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", "name": "ikeversion", "type": "string" }, - {}, { - "description": "is connection for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the vpn gateway ID", + "name": "s2svpngatewayid", + "type": "string" }, { "description": "Lifetime of ESP SA of customer gateway", @@ -54766,39 +54950,30 @@ "type": "long" }, { - "description": "the vpn gateway ID", - "name": "s2svpngatewayid", + "description": "the project id", + "name": "projectid", "type": "string" }, { - "description": "Split multiple remote networks into multiple phase 2 SAs. Often used with Cisco some products.", - "name": "splitconnections", - "type": "boolean" - }, - { - "description": "Lifetime of IKE SA of customer gateway", - "name": "ikelifetime", - "type": "long" - }, - { - "description": "IKE policy of the customer gateway", - "name": "ikepolicy", + "description": "the domain path of the owner", + "name": "domainpath", "type": "string" }, { - "description": "the connection ID", - "name": "id", + "description": "the project name", + "name": "project", "type": "string" }, + {}, { - "description": "the domain id of the owner", - "name": "domainid", - "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": "if DPD is enabled for customer gateway", + "name": "dpd", + "type": "boolean" }, { "description": "public ip address id of the customer gateway", @@ -54806,81 +54981,101 @@ "type": "string" }, { - "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "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": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "State of vpn connection", + "name": "state", "type": "string" }, { - "description": "the domain path of the owner", - "name": "domainpath", + "description": "the domain name of the owner", + "name": "domain", "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": "the customer gateway ID", + "name": "s2scustomergatewayid", + "type": "string" + }, { "description": "IPsec Preshared-Key of the customer gateway", "name": "ipsecpsk", "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": "State of vpn connection", - "name": "state", + "name": "passive", + "type": "boolean" + }, + { + "description": "ESP policy of the customer gateway", + "name": "esppolicy", "type": "string" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", + "type": "string" }, { - "description": "State of vpn connection", - "name": "passive", - "type": "boolean" + "description": "Lifetime of IKE SA of customer gateway", + "name": "ikelifetime", + "type": "long" }, { - "description": "the public IP address", - "name": "publicip", + "description": "the owner", + "name": "account", "type": "string" }, { - "description": "the project name", - "name": "project", + "description": "the connection ID", + "name": "id", "type": "string" }, - {}, { - "description": "the project id", - "name": "projectid", + "description": "the public IP address", + "name": "publicip", "type": "string" }, { - "description": "the owner", - "name": "account", + "description": "the date and time the host was created", + "name": "created", + "type": "date" + }, + { + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" + }, + { + "description": "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", "type": "string" }, { - "description": "the domain name of the owner", - "name": "domain", + "description": "the domain id of the owner", + "name": "domainid", "type": "string" - } + }, + {} ] }, { @@ -54913,44 +55108,44 @@ ], "related": "createTungstenFabricPolicy,listTungstenFabricPolicy,applyTungstenFabricPolicy", "response": [ + {}, + {}, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "Tungsten-Fabric policy name", + "name": "name", "type": "string" }, - {}, - {}, { "description": "Tungsten-Fabric provider zone id", "name": "zoneid", "type": "long" }, { - "description": "Tungsten-Fabric tag type uuid", - "name": "uuid", + "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": "the UUID of the latest async 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" - } + {} ] }, { @@ -54958,13 +55153,6 @@ "isasync": false, "name": "updateCloudToUseObjectStore", "params": [ - { - "description": "the image store provider name", - "length": 255, - "name": "provider", - "required": true, - "type": "string" - }, { "description": "the URL for the image store", "length": 255, @@ -54985,31 +55173,22 @@ "name": "details", "required": false, "type": "map" + }, + { + "description": "the image store provider name", + "length": 255, + "name": "provider", + "required": true, + "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 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": "defines if store is read-only", "name": "readonly", @@ -55020,24 +55199,40 @@ "name": "disksizeused", "type": "long" }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the url of the image store", + "name": "url", + "type": "string" + }, + {}, + { + "description": "the protocol of the image store", + "name": "protocol", + "type": "string" + }, { "description": "the provider name of the image store", "name": "providername", "type": "string" }, { - "description": "the Zone ID of the image store", - "name": "zoneid", - "type": "string" + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the image store", + "name": "name", "type": "string" }, { - "description": "the url of the image store", - "name": "url", + "description": "the Zone name of the image store", + "name": "zonename", "type": "string" }, { @@ -55046,19 +55241,19 @@ "type": "boolean" }, { - "description": "the protocol of the image store", - "name": "protocol", - "type": "string" + "description": "the scope of the image store", + "name": "scope", + "type": "scopetype" }, + {}, { - "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 Zone ID of the image store", + "name": "zoneid", "type": "string" } ], @@ -55078,22 +55273,28 @@ "type": "uuid" }, { - "description": "the end AS Number", + "description": "the start AS Number", "length": 255, - "name": "endasn", + "name": "startasn", "required": true, "type": "long" }, { - "description": "the start AS Number", + "description": "the end AS Number", "length": 255, - "name": "startasn", + "name": "endasn", "required": true, "type": "long" } ], "related": "listASNRanges", "response": [ + { + "description": "ID of the AS Number Range", + "name": "id", + "type": "string" + }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -55106,25 +55307,19 @@ }, {}, { - "description": "End AS Number", - "name": "endasn", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { "description": "Start AS Number", "name": "startasn", "type": "long" }, { - "description": "ID of the AS Number Range", - "name": "id", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "End AS Number", + "name": "endasn", + "type": "long" }, { "description": "Zone ID", @@ -55164,11 +55359,28 @@ ], "related": "createTungstenFabricLogicalRouter,removeTungstenFabricNetworkGatewayFromLogicalRouter,listTungstenFabricLogicalRouter", "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": "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 logical router uuid", "name": "uuid", @@ -55179,27 +55391,10 @@ "name": "name", "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": "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" } ] }, @@ -55208,6 +55403,14 @@ "isasync": false, "name": "listTungstenFabricNic", "params": [ + { + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "createZone,listZones,listZones", + "required": false, + "type": "uuid" + }, { "description": "", "length": 255, @@ -55215,6 +55418,13 @@ "required": false, "type": "integer" }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, { "description": "List by keyword", "length": 255, @@ -55228,34 +55438,15 @@ "name": "nicuuid", "required": false, "type": "string" - }, - { - "description": "the ID of zone", - "length": 255, - "name": "zoneid", - "related": "createZone,listZones,listZones", - "required": false, - "type": "uuid" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" } ], "related": "", "response": [ - { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", - "type": "string" - }, + {}, {}, { - "description": "Tungsten-Fabric nic uuid", - "name": "uuid", + "description": "Tungsten-Fabric nic name", + "name": "name", "type": "string" }, { @@ -55263,15 +55454,19 @@ "name": "zoneid", "type": "long" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Tungsten-Fabric nic uuid", + "name": "uuid", "type": "string" }, { - "description": "Tungsten-Fabric nic name", - "name": "name", + "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" }, { @@ -55286,13 +55481,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, @@ -55314,41 +55502,48 @@ "name": "pagesize", "required": false, "type": "integer" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" } ], "related": "addVmwareDc", "response": [ - {}, - {}, - { - "description": "The VMware Datacenter ID", - "name": "id", - "type": "string" - }, { "description": "The VMware Datacenter name", "name": "name", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "The VMware vCenter name/ip", - "name": "vcenter", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, + {}, { "description": "the Zone ID associated with this VMware Datacenter", "name": "zoneid", "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The VMware Datacenter ID", + "name": "id", "type": "string" + }, + { + "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" } ] }, @@ -55358,25 +55553,25 @@ "name": "applyTungstenFabricPolicy", "params": [ { - "description": "the uuid of network", + "description": "the minor sequence of Tungsten-Fabric policy", "length": 255, - "name": "networkuuid", + "name": "minorsequence", "required": true, - "type": "string" + "type": "integer" }, { - "description": "the major sequence of Tungsten-Fabric policy", + "description": "the uuid of network", "length": 255, - "name": "majorsequence", + "name": "networkuuid", "required": true, - "type": "integer" + "type": "string" }, { - "description": "the minor sequence of Tungsten-Fabric policy", + "description": "the uuid of Tungsten-Fabric policy", "length": 255, - "name": "minorsequence", + "name": "policyuuid", "required": true, - "type": "integer" + "type": "string" }, { "description": "the ID of zone", @@ -55387,26 +55582,29 @@ "type": "uuid" }, { - "description": "the uuid of Tungsten-Fabric policy", + "description": "the major sequence of Tungsten-Fabric policy", "length": 255, - "name": "policyuuid", + "name": "majorsequence", "required": true, - "type": "string" + "type": "integer" } ], "related": "createTungstenFabricPolicy,listTungstenFabricPolicy", "response": [ { - "description": "Tungsten-Fabric tag type uuid", - "name": "uuid", + "description": "Tungsten-Fabric policy name", + "name": "name", "type": "string" }, - {}, - {}, + { + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" + }, {}, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -55414,24 +55612,21 @@ "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 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", + "description": "Tungsten-Fabric tag type uuid", + "name": "uuid", "type": "string" } ] @@ -55442,55 +55637,56 @@ "name": "listZones", "params": [ { - "description": "flag to display the resource image for the zones", + "description": "List by keyword", "length": 255, - "name": "showicon", + "name": "keyword", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "flag to display the capacity of the zones", + "description": "the network type of the zone that the virtual machine belongs to", "length": 255, - "name": "showcapacities", + "name": "networktype", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "the ID of the zone", + "description": "flag to display the resource image for the zones", "length": 255, - "name": "id", - "related": "createZone,listZones,listZones", + "name": "showicon", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "the network type of the zone that the virtual machine belongs to", + "description": "the name of the storage access group", "length": 255, - "name": "networktype", + "name": "storageaccessgroup", "required": false, + "since": "4.21.0", "type": "string" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "true if you want to retrieve all available Zones. False if you only want to return the Zones from which you have at least one VM. Default is false.", + "description": "the IDs of the zones, mutually exclusive with id", "length": 255, - "name": "available", + "name": "ids", + "related": "createZone,listZones,listZones", "required": false, - "type": "boolean" + "since": "4.19.0", + "type": "list" }, { - "description": "the ID of the domain associated with the zone", + "description": "true if you want to retrieve all available Zones. False if you only want to return the Zones from which you have at least one VM. Default is false.", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "name": "available", "required": false, - "type": "uuid" + "type": "boolean" }, { "description": "List zones by resource tags (key/value pairs)", @@ -55501,80 +55697,48 @@ "type": "map" }, { - "description": "", + "description": "the name of the zone", "length": 255, - "name": "pagesize", + "name": "name", "required": false, - "type": "integer" + "type": "string" }, { - "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 IDs of the zones, mutually exclusive with id", + "description": "the ID of the zone", "length": 255, - "name": "ids", + "name": "id", "related": "createZone,listZones,listZones", "required": false, - "since": "4.19.0", - "type": "list" + "type": "uuid" }, { - "description": "", + "description": "flag to display the capacity of the zones", "length": 255, - "name": "page", + "name": "showcapacities", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "the name of the zone", + "description": "the ID of the domain associated with the zone", "length": 255, - "name": "name", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, - "type": "string" + "type": "uuid" } ], "related": "createZone,listZones", "response": [ { - "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": "Allow end users to specify VR MTU", - "name": "allowuserspecifyvrmtu", - "type": "boolean" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "true, if zone is NSX enabled", - "name": "isnsxenabled", - "type": "boolean" - }, - { - "description": "true if security groups support is enabled, false otherwise", - "name": "securitygroupsenabled", - "type": "boolean" - }, - { - "description": "the first DNS for the Zone", - "name": "dns1", + "description": "the name of the containing domain, null for public zones", + "name": "domainname", "type": "string" }, { @@ -55583,167 +55747,171 @@ "type": "string" }, { - "description": "the second internal DNS for the Zone", - "name": "internaldns2", + "description": "Network domain name for the networks in the zone", + "name": "domain", "type": "string" }, { - "description": "the first IPv6 DNS for the Zone", - "name": "ip6dns1", + "description": "Zone name", + "name": "name", "type": "string" }, { - "description": "Used GPUs in the Zone", - "name": "gpuused", - "type": "long" + "description": "true, if routed network/vpc is enabled", + "name": "routedmodeenabled", + "type": "boolean" }, { - "description": "The maximum value the MTU can have on the VR's public interfaces", - "name": "routerpublicinterfacemaxmtu", - "type": "integer" + "description": "the allocation state of the cluster", + "name": "allocationstate", + "type": "string" }, - {}, { - "description": "the dhcp Provider for the Zone", - "name": "dhcpprovider", + "description": "the first internal DNS for the Zone", + "name": "internaldns1", "type": "string" }, { - "description": "the type of the zone - core or edge", - "name": "type", + "description": "Zone Token", + "name": "zonetoken", "type": "string" }, { - "description": "Meta data associated with the zone (key/value pairs)", - "name": "resourcedetails", - "type": "map" + "description": "The maximum value the MTU can have on the VR's private interfaces", + "name": "routerprivateinterfacemaxmtu", + "type": "integer" }, { - "description": "Network domain name for the networks in the zone", - "name": "domain", + "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": "the guest CIDR address for the Zone", + "name": "guestcidraddress", + "type": "string" }, { - "description": "Total GPUs in the Zone", - "name": "gputotal", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the display text of the zone", - "name": "displaytext", + "description": "comma-separated list of storage access groups for the zone", + "name": "storageaccessgroups", "type": "string" }, { - "description": "the name of the containing domain, null for public zones", - "name": "domainname", + "description": "the first DNS for the Zone", + "name": "dns1", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if security groups support is enabled, false otherwise", + "name": "securitygroupsenabled", "type": "boolean" }, { - "description": "Zone name", - "name": "name", - "type": "string" - }, - { - "description": "the second DNS for the Zone", - "name": "dns2", - "type": "string" + "description": "The maximum value the MTU can have on the VR's public interfaces", + "name": "routerpublicinterfacemaxmtu", + "type": "integer" }, { - "description": "The maximum value the MTU can have on the VR's private interfaces", - "name": "routerprivateinterfacemaxmtu", - "type": "integer" + "description": "the second IPv6 DNS for the Zone", + "name": "ip6dns2", + "type": "string" }, { - "description": "the list of resource tags associated with zone.", - "name": "tags", + "description": "the capacity of the Zone", + "name": "capacity", "response": [ { - "description": "tag key name", - "name": "key", + "description": "the capacity name", + "name": "name", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", - "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 total capacity available", + "name": "capacitytotal", + "type": "long" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the Cluster ID", + "name": "clusterid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" + }, + { + "description": "the Pod ID", + "name": "podid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the Zone ID", + "name": "zoneid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the Zone name", + "name": "zonename", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "The tag for the capacity type", + "name": "tag", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the Pod name", + "name": "podname", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the Cluster name", + "name": "clustername", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the percentage of capacity currently in use", + "name": "percentused", "type": "string" + }, + { + "description": "the capacity type", + "name": "type", + "type": "short" } ], - "type": "set" + "type": "list" }, { - "description": "the network type of the zone; can be Basic or Advanced", - "name": "networktype", + "description": "the display text of the zone", + "name": "displaytext", "type": "string" }, { - "description": "comma-separated list of storage access groups for the zone", - "name": "storageaccessgroups", - "type": "string" + "description": "Used GPUs in the Zone", + "name": "gpuused", + "type": "long" }, { - "description": "the UUID of the containing domain, null for public zones", - "name": "domainid", - "type": "string" + "description": "Allow end users to specify VR MTU", + "name": "allowuserspecifyvrmtu", + "type": "boolean" }, { - "description": "Zone description", - "name": "description", - "type": "string" + "description": "Meta data associated with the zone (key/value pairs)", + "name": "resourcedetails", + "type": "map" }, { "description": "External network provider if any", @@ -55751,208 +55919,145 @@ "type": "string" }, { - "description": "the second IPv6 DNS for the Zone", - "name": "ip6dns2", - "type": "string" - }, - { - "description": "Zone id", - "name": "id", + "description": "the UUID of the containing domain, null for public zones", + "name": "domainid", "type": "string" }, { - "description": "the allocation state of the cluster", - "name": "allocationstate", + "description": "the second internal DNS for the Zone", + "name": "internaldns2", "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", - "type": "string" + "description": "Total GPUs in the Zone", + "name": "gputotal", + "type": "long" }, { - "description": "the guest CIDR address for the Zone", - "name": "guestcidraddress", + "description": "the dhcp Provider for the Zone", + "name": "dhcpprovider", "type": "string" }, { - "description": "the capacity of the Zone", - "name": "capacity", + "description": "the list of resource tags associated with zone.", + "name": "tags", "response": [ { - "description": "the Cluster name", - "name": "clustername", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "The tag for the capacity type", - "name": "tag", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the capacity currently in allocated", - "name": "capacityallocated", - "type": "long" - }, - { - "description": "the capacity name", - "name": "name", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the total capacity available", - "name": "capacitytotal", - "type": "long" - }, - { - "description": "the Pod ID", - "name": "podid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the Cluster ID", - "name": "clusterid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the Zone name", - "name": "zonename", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the percentage of capacity currently in use", - "name": "percentused", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the Zone ID", - "name": "zoneid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the Pod name", - "name": "podname", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the capacity type", - "name": "type", - "type": "short" + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" }, { - "description": "the capacity currently in use", - "name": "capacityused", - "type": "long" + "description": "id of the resource", + "name": "resourceid", + "type": "string" } ], - "type": "list" + "type": "set" }, { - "description": "Zone Token", - "name": "zonetoken", - "type": "string" - } - ] - }, - { - "description": "Removes a public IP address from quarantine. Only IPs in active quarantine can be removed.", - "isasync": false, - "name": "removeQuarantinedIp", - "params": [ - { - "description": "The reason for removing the public IP address from quarantine prematurely.", - "length": 255, - "name": "removalreason", - "required": true, + "description": "the first IPv6 DNS for the Zone", + "name": "ip6dns1", "type": "string" }, { - "description": "The ID of the public IP address in active quarantine. Either the IP address is informed, or the ID of the IP address in quarantine.", - "length": 255, - "name": "id", - "related": "listQuarantinedIps,updateQuarantinedIp,removeQuarantinedIp", - "required": false, - "type": "uuid" - }, - { - "description": "The public IP address in active quarantine. Either the IP address is informed, or the ID of the IP address in quarantine.", - "length": 255, - "name": "ipaddress", - "required": false, - "type": "string" - } - ], - "related": "listQuarantinedIps,updateQuarantinedIp", - "response": [ - { - "description": "ID of the account that removed the IP from quarantine.", - "name": "removeraccountid", + "description": "the second DNS for the Zone", + "name": "dns2", "type": "string" }, { - "description": "ID of the quarantine process.", - "name": "id", + "description": "the type of the zone - core or edge", + "name": "type", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "true, if zone contains clusters and hosts from different CPU architectures", + "name": "ismultiarch", + "type": "boolean" }, + {}, { - "description": "Account name of the previous public IP address owner.", - "name": "previousownername", - "type": "string" + "description": "true if local storage offering enabled, false otherwise", + "name": "localstorageenabled", + "type": "boolean" }, { - "description": "End date for the quarantine.", - "name": "enddate", - "type": "date" + "description": "true, if zone is NSX enabled", + "name": "isnsxenabled", + "type": "boolean" }, { - "description": "The public IP address in quarantine.", - "name": "ipaddress", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "When the quarantine was removed.", - "name": "removed", - "type": "date" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, - {}, { - "description": "The reason for removing the IP from quarantine prematurely.", - "name": "removalreason", + "description": "Zone description", + "name": "description", "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 UUID of the latest async 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": "Zone id", + "name": "id", + "type": "string" } - ], - "since": "4.19" + ] }, { "description": "Create an extension", @@ -55967,11 +56072,11 @@ "type": "string" }, { - "description": "Only honored when type is Orchestrator. Whether prepare VM is needed or not", + "description": "Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].endpoint.url=urlvalue", "length": 255, - "name": "orchestratorrequirespreparevm", + "name": "details", "required": false, - "type": "boolean" + "type": "map" }, { "description": "Type of the extension", @@ -55980,6 +56085,13 @@ "required": true, "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": "Name of the extension", "length": 255, @@ -55994,13 +56106,6 @@ "required": false, "type": "string" }, - { - "description": "Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].endpoint.url=urlvalue", - "length": 255, - "name": "details", - "required": false, - "type": "map" - }, { "description": "Description of the extension", "length": 255, @@ -56011,50 +56116,29 @@ ], "related": "listExtensions,deleteExtension,updateExtension,registerExtension,unregisterExtension", "response": [ - {}, { - "description": "True if the extension is added by admin", - "name": "isuserdefined", + "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": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The details of the extension", + "name": "details", + "type": "map" }, - {}, { "description": "Name of the extension", "name": "name", "type": "string" }, - { - "description": "ID of the extension", - "name": "id", - "type": "string" - }, - { - "description": "True if the extension path is in ready state across management servers", - "name": "pathready", - "type": "boolean" - }, { "description": "List of resources to which extension is registered to", "name": "resources", "response": [ { - "description": "Creation timestamp of the mapping", - "name": "created", - "type": "date" - }, - { - "description": "Name of the resource associated with this mapping", - "name": "name", + "description": "Type of the resource", + "name": "type", "type": "string" }, { @@ -56062,22 +56146,64 @@ "name": "id", "type": "string" }, - { - "description": "Type of the resource", - "name": "type", - "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": "Creation timestamp of the mapping", + "name": "created", + "type": "date" } ], "type": "list" }, { - "description": "Removal timestamp of the extension, if applicable", - "name": "removed", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "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": "Type of the extension", + "name": "type", + "type": "string" + }, + { + "description": "ID of the extension", + "name": "id", + "type": "string" + }, + {}, + { + "description": "Description of the extension", + "name": "description", + "type": "string" + }, + { + "description": "The state of the extension", + "name": "state", + "type": "string" + }, + {}, + { + "description": "Creation timestamp of the extension", + "name": "created", "type": "date" }, { @@ -56085,11 +56211,69 @@ "name": "path", "type": "string" }, + { + "description": "Removal timestamp of the extension, if applicable", + "name": "removed", + "type": "date" + } + ], + "since": "4.21.0" + }, + { + "description": "Removes a public IP address from quarantine. Only IPs in active quarantine can be removed.", + "isasync": false, + "name": "removeQuarantinedIp", + "params": [ + { + "description": "The public IP address in active quarantine. Either the IP address is informed, or the ID of the IP address in quarantine.", + "length": 255, + "name": "ipaddress", + "required": false, + "type": "string" + }, + { + "description": "The ID of the public IP address in active quarantine. Either the IP address is informed, or the ID of the IP address in quarantine.", + "length": 255, + "name": "id", + "related": "listQuarantinedIps,updateQuarantinedIp,removeQuarantinedIp", + "required": false, + "type": "uuid" + }, + { + "description": "The reason for removing the public IP address from quarantine prematurely.", + "length": 255, + "name": "removalreason", + "required": true, + "type": "string" + } + ], + "related": "listQuarantinedIps,updateQuarantinedIp", + "response": [ + { + "description": "When the quarantine was created.", + "name": "created", + "type": "date" + }, + { + "description": "Account name of the previous public IP address owner.", + "name": "previousownername", + "type": "string" + }, {}, { - "description": "The details of the extension", - "name": "details", - "type": "map" + "description": "ID of the account that removed the IP from quarantine.", + "name": "removeraccountid", + "type": "string" + }, + { + "description": "Account ID of the previous public IP address owner.", + "name": "previousownerid", + "type": "string" + }, + { + "description": "The reason for removing the IP from quarantine prematurely.", + "name": "removalreason", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", @@ -56097,22 +56281,33 @@ "type": "string" }, { - "description": "The state of the extension", - "name": "state", + "description": "The public IP address in quarantine.", + "name": "ipaddress", "type": "string" }, { - "description": "Type of the extension", - "name": "type", + "description": "ID of the quarantine process.", + "name": "id", "type": "string" }, + {}, { - "description": "Description of the extension", - "name": "description", - "type": "string" + "description": "End date for the quarantine.", + "name": "enddate", + "type": "date" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "When the quarantine was removed.", + "name": "removed", + "type": "date" } ], - "since": "4.21.0" + "since": "4.19" }, { "description": "Deletes the backup schedule of a VM", @@ -56123,7 +56318,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,createVMFromBackup,createVMFromBackup,assignVirtualMachine,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", "required": false, "type": "uuid" }, @@ -56138,12 +56333,18 @@ } ], "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", @@ -56153,12 +56354,6 @@ "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" - }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" } ], "since": "4.14.0" @@ -56168,13 +56363,6 @@ "isasync": false, "name": "listBackupProviderOfferings", "params": [ - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, { "description": "", "length": 255, @@ -56196,15 +56384,38 @@ "name": "page", "required": false, "type": "integer" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" } ], "related": "importBackupOffering,listBackupOfferings,updateBackupOffering", "response": [ { - "description": "whether offering allows user driven ad-hoc/scheduled backups", - "name": "allowuserdrivenbackups", + "description": "the date this backup offering was created", + "name": "created", + "type": "date" + }, + {}, + { + "description": "the backups with this offering can be used to create Instances on all Zones", + "name": "crosszoneinstancecreation", "type": "boolean" }, + { + "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": "name for the backup offering", "name": "name", @@ -56216,45 +56427,34 @@ "type": "string" }, { - "description": "external ID on the provider side", - "name": "externalid", - "type": "string" - }, - { - "description": "ID of the backup offering", - "name": "id", + "description": "provider name", + "name": "provider", "type": "string" }, - {}, { - "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": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "ID of the backup offering", + "name": "id", "type": "string" }, { - "description": "provider name", - "name": "provider", + "description": "external ID on the provider side", + "name": "externalid", "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": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ], @@ -56276,26 +56476,26 @@ ], "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": "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" - }, {} ] }, @@ -56304,13 +56504,6 @@ "isasync": false, "name": "listNetscalerLoadBalancerNetworks", "params": [ - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, { "description": "netscaler load balancer device ID", "length": 255, @@ -56320,124 +56513,297 @@ "type": "uuid" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" } ], "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "response": [ + { + "description": "the project id of the ipaddress", + "name": "projectid", + "type": "string" + }, + { + "description": "the physical network id", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "the name of the network", + "name": "name", + "type": "string" + }, + { + "description": "the name of the Network associated with this private gateway", + "name": "associatednetwork", + "type": "string" + }, + { + "description": "the network's gateway", + "name": "gateway", + "type": "string" + }, + { + "description": "list networks available for vm deployment", + "name": "canusefordeploy", + "type": "boolean" + }, + { + "description": "the ID of the Network associated with this private gateway", + "name": "associatednetworkid", + "type": "string" + }, + { + "description": "Broadcast domain type of the network", + "name": "broadcastdomaintype", + "type": "string" + }, + { + "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", + "name": "cidr", + "type": "string" + }, + { + "description": "an optional field, whether to the display the network to the end user or not.", + "name": "displaynetwork", + "type": "boolean" + }, { "description": "Base64 string representation of the resource icon", "name": "icon", "type": "resourceiconresponse" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "The Ipv6 routing type of network offering", + "name": "ip6routing", "type": "string" }, { - "description": "network offering id the network is created from", - "name": "networkofferingid", + "description": "list networks that are persistent", + "name": "ispersistent", + "type": "boolean" + }, + { + "description": "true if network offering is ip conserve mode enabled", + "name": "networkofferingconservemode", + "type": "boolean" + }, + { + "description": "Name of the VPC to which this network belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "The IPv4 routing type of network", + "name": "ip4routing", + "type": "string" + }, + { + "description": "availability of the network offering the network is created from", + "name": "networkofferingavailability", "type": "string" }, + {}, { "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", "name": "broadcasturi", "type": "string" }, + { + "description": "name of the network offering the network is created from", + "name": "networkofferingname", + "type": "string" + }, + { + "description": "AS NUMBER", + "name": "asnumber", + "type": "long" + }, + { + "description": "true if network can span multiple zones", + "name": "strechedl2subnet", + "type": "boolean" + }, + { + "description": "ACL name associated with the VPC network", + "name": "aclname", + "type": "string" + }, + { + "description": "acl type - access type to the network", + "name": "acltype", + "type": "string" + }, + { + "description": "Tungsten-Fabric virtual router the network belongs to", + "name": "tungstenvirtualrouteruuid", + "type": "string" + }, { "description": "true if guest network default egress policy is allow; false if default egress policy is deny", "name": "egressdefaultpolicy", "type": "boolean" }, { - "description": "the name of the network", - "name": "name", + "description": "the domain id of the network owner", + "name": "domainid", "type": "string" }, { - "description": "the network's gateway", - "name": "gateway", + "description": "the traffic type of the network", + "name": "traffictype", "type": "string" }, { - "description": "the domain name of the network owner", - "name": "domain", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "The BGP peers for the network", + "name": "bgppeers", + "type": "set" }, { - "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": "VPC the network belongs to", + "name": "vpcid", + "type": "string" + }, + { + "description": "the displaytext of the network", + "name": "displaytext", + "type": "string" + }, { "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 network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE", - "name": "networkcidr", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "list networks available for vm deployment", - "name": "canusefordeploy", + "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", + "name": "zonesnetworkspans", + "type": "set" + }, + { + "description": "the type of the network", + "name": "type", + "type": "string" + }, + { + "description": "path of the Domain the network belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" + }, + { + "description": "the date this network was created", + "name": "created", + "type": "date" + }, + { + "description": "The internet protocol of network offering", + "name": "internetprotocol", + "type": "string" + }, + { + "description": "ACL Id associated with the VPC network", + "name": "aclid", + "type": "string" + }, + { + "description": "zone id of the network", + "name": "zoneid", + "type": "string" + }, + { + "description": "true if users from subdomains can access the domain level network", + "name": "subdomainaccess", + "type": "boolean" + }, + { + "description": "true if network supports specifying vlan, false otherwise", + "name": "specifyvlan", "type": "boolean" }, + { + "description": "the second IPv6 DNS for the network", + "name": "ip6dns2", + "type": "string" + }, { "description": "the list of resource tags associated with network", "name": "tags", "response": [ { - "description": "tag key name", - "name": "key", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "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": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { @@ -56446,108 +56812,68 @@ "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "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": "resource type", - "name": "resourcetype", + "description": "id of the resource", + "name": "resourceid", "type": "string" } ], "type": "list" }, { - "description": "The external id of the network", - "name": "externalid", - "type": "string" - }, - { - "description": "the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes", - "name": "reservediprange", - "type": "string" - }, - { - "description": "the type of the network", - "name": "type", - "type": "string" - }, - { - "description": "true if network supports specifying vlan, false otherwise", - "name": "specifyvlan", - "type": "boolean" - }, - { - "description": "the second IPv6 DNS for the network", - "name": "ip6dns2", - "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", + "description": "the name of the zone the network belongs to", + "name": "zonename", "type": "string" }, { - "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", - "name": "cidr", + "description": "the owner of the network", + "name": "account", "type": "string" }, { - "description": "true if network offering is ip conserve mode enabled", - "name": "networkofferingconservemode", - "type": "boolean" - }, - { - "description": "the name of the Network associated with this private gateway", - "name": "associatednetwork", + "description": "the first IPv6 DNS for the network", + "name": "ip6dns1", "type": "string" }, { - "description": "Name of the VPC to which this network belongs", - "name": "vpcname", + "description": "state of the network", + "name": "state", "type": "string" }, { - "description": "The Ipv6 routing type of network offering", - "name": "ip6routing", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "The external id of the network", + "name": "externalid", "type": "string" }, { - "description": "related to what other network configuration", - "name": "related", + "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": "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": "the list of services", "name": "service", @@ -56558,181 +56884,107 @@ "type": "string" }, { - "description": "the service provider name", - "name": "provider", + "description": "the list of capabilities", + "name": "capability", "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": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" }, { - "description": "uuid of the network provider", - "name": "id", + "description": "the capability name", + "name": "name", "type": "string" }, { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", + "description": "the capability value", + "name": "value", "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", + "description": "the service provider name", + "name": "provider", "response": [ { - "description": "the capability name", - "name": "name", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the capability value", - "name": "value", + "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" - } - ], - "type": "list" - }, - { - "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 provider name", + "name": "name", + "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" + }, + { + "description": "uuid of the network provider", + "name": "id", + "type": "string" + } + ], + "type": "list" + } + ], + "type": "list" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "MTU configured on the network VR's public facing interfaces", + "name": "publicmtu", "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", - "type": "string" - }, { "description": "true if network is system, false otherwise", "name": "issystem", "type": "boolean" }, - { - "description": "The vlan of the network. This parameter is visible to ROOT admins only", - "name": "vlan", - "type": "string" - }, - { - "description": "list networks that are persistent", - "name": "ispersistent", - "type": "boolean" - }, - { - "description": "ACL Id associated with the VPC network", - "name": "aclid", - "type": "string" - }, - { - "description": "true if network can span multiple zones", - "name": "strechedl2subnet", - "type": "boolean" - }, - { - "description": "display text of the network offering the network is created from", - "name": "networkofferingdisplaytext", - "type": "string" - }, - { - "description": "the ID of the Network associated with this private gateway", - "name": "associatednetworkid", - "type": "string" - }, { "description": "the id of the network", "name": "id", "type": "string" }, + { + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip4routes", + "type": "set" + }, + {}, { "description": "the second IPv4 DNS for the network", "name": "dns2", "type": "string" }, { - "description": "zone id of the network", - "name": "zoneid", - "type": "string" + "description": "the details of the network", + "name": "details", + "type": "map" }, { - "description": "the domain id of the network owner", - "name": "domainid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the gateway of IPv6 network", @@ -56740,18 +56992,18 @@ "type": "string" }, { - "description": "true if users from subdomains can access the domain level network", - "name": "subdomainaccess", - "type": "boolean" + "description": "the domain name of the network owner", + "name": "domain", + "type": "string" }, { - "description": "the network's netmask", - "name": "netmask", + "description": "UUID of AS NUMBER", + "name": "asnumberid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the first IPv4 DNS for the network", + "name": "dns1", "type": "string" }, { @@ -56764,101 +57016,49 @@ "name": "isdefault", "type": "boolean" }, - { - "description": "acl type - access type to the network", - "name": "acltype", - "type": "string" - }, - { - "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", - "name": "zonesnetworkspans", - "type": "set" - }, - { - "description": "The 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", + "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 the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, { "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", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "The IPv4 routing type of network", - "name": "ip4routing", + "description": "the network's netmask", + "name": "netmask", "type": "string" }, { - "description": "an optional field, whether to the display the network to the end user or not.", - "name": "displaynetwork", + "description": "if network offering supports vm autoscaling feature", + "name": "supportsvmautoscaling", "type": "boolean" }, { - "description": "state of the network", - "name": "state", + "description": "The vlan of the network. This parameter is visible to ROOT admins only", + "name": "vlan", "type": "string" }, { - "description": "the first IPv6 DNS for the network", - "name": "ip6dns1", + "description": "related to what other network configuration", + "name": "related", "type": "string" } ] @@ -56879,9 +57079,9 @@ ], "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", @@ -56894,46 +57094,59 @@ "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": "Lists supported methods of network isolation", + "description": "Lists host HA resources", "isasync": false, - "name": "listNetworkIsolationMethods", + "name": "listHostHAResources", "params": [ { - "description": "", + "description": "List by host ID", "length": 255, - "name": "pagesize", + "name": "hostid", + "related": "addBaremetalHost,cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost", "required": false, - "type": "integer" + "type": "uuid" + } + ], + "related": "configureHAForHost,enableHAForHost,disableHAForHost,listHostHAProviders", + "response": [ + {}, + { + "description": "operation status", + "name": "status", + "type": "boolean" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, + "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": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the HA state of the host", + "name": "hastate", + "type": "hastate" + }, + { + "description": "the host HA provider", + "name": "haprovider", "type": "string" - } - ], - "related": "", - "response": [ + }, { - "description": "Network isolation method name", - "name": "name", + "description": "the ID of the host", + "name": "hostid", "type": "string" }, {}, @@ -56941,84 +57154,64 @@ "description": "the UUID of the latest async 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.2.0" + "since": "4.11" }, { - "description": "Lists host HA resources", + "description": "Lists supported methods of network isolation", "isasync": false, - "name": "listHostHAResources", + "name": "listNetworkIsolationMethods", "params": [ { - "description": "List by host ID", + "description": "List by keyword", "length": 255, - "name": "hostid", - "related": "cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost,addBaremetalHost", + "name": "keyword", "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", - "type": "boolean" - }, - { - "description": "the HA state of the host", - "name": "hastate", - "type": "hastate" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + } + ], + "related": "", + "response": [ + {}, { - "description": "the host HA provider", - "name": "haprovider", + "description": "Network isolation method name", + "name": "name", "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", + "type": "string" } ], - "since": "4.11" + "since": "4.2.0" }, { "description": "list Tungsten-Fabric firewall policy", "isasync": false, "name": "listTungstenFabricFirewallPolicy", "params": [ - { - "description": "the uuid of Tungsten-Fabric application policy set", - "length": 255, - "name": "applicationpolicysetuuid", - "required": false, - "type": "string" - }, { "description": "List by keyword", "length": 255, @@ -57027,16 +57220,16 @@ "type": "string" }, { - "description": "", + "description": "the uuid of Tungsten-Fabric firewall policy", "length": 255, - "name": "pagesize", + "name": "firewallpolicyuuid", "required": false, - "type": "integer" + "type": "string" }, { - "description": "the uuid of Tungsten-Fabric firewall policy", + "description": "the uuid of Tungsten-Fabric application policy set", "length": 255, - "name": "firewallpolicyuuid", + "name": "applicationpolicysetuuid", "required": false, "type": "string" }, @@ -57048,6 +57241,13 @@ "required": false, "type": "uuid" }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, { "description": "", "length": 255, @@ -57059,41 +57259,41 @@ "related": "createTungstenFabricFirewallPolicy", "response": [ { - "description": "Tungsten-Fabric firewall policy uuid", - "name": "uuid", + "description": "Tungsten-Fabric firewall policy name", + "name": "name", "type": "string" }, - { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" - }, - {}, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", - "type": "string" - }, { "description": "list Tungsten-Fabric firewall rule", "name": "firewallrule", "type": "list" }, { - "description": "Tungsten-Fabric firewall policy name", - "name": "name", - "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": "Tungsten-Fabric provider zone name", + "name": "zonename", + "type": "string" + }, + { + "description": "Tungsten-Fabric firewall policy uuid", + "name": "uuid", + "type": "string" } ] }, @@ -57103,26 +57303,25 @@ "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", + "description": "the name of the backup offering", "length": 255, - "name": "allowuserdrivenbackups", + "name": "name", "required": true, - "type": "boolean" + "type": "string" }, { - "description": "the name of the backup offering", + "description": "Whether users are allowed to create adhoc backups and backup schedules", "length": 255, - "name": "name", + "name": "allowuserdrivenbackups", "required": true, - "type": "string" + "type": "boolean" }, { "description": "the description of the backup offering", @@ -57132,15 +57331,21 @@ "type": "string" }, { - "description": "The backup offering ID (from backup provider side)", + "description": "The zone ID", "length": 255, - "name": "externalid", + "name": "zoneid", + "related": "createZone,listZones", "required": true, - "type": "string" + "type": "uuid" } ], "related": "listBackupOfferings,updateBackupOffering", "response": [ + { + "description": "the date this backup offering was created", + "name": "created", + "type": "date" + }, { "description": "name for the backup offering", "name": "name", @@ -57151,17 +57356,6 @@ "name": "externalid", "type": "string" }, - { - "description": "whether offering allows user driven ad-hoc/scheduled backups", - "name": "allowuserdrivenbackups", - "type": "boolean" - }, - { - "description": "ID of the backup offering", - "name": "id", - "type": "string" - }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -57172,17 +57366,32 @@ "name": "zoneid", "type": "string" }, - {}, - { - "description": "the date this backup offering was created", - "name": "created", - "type": "date" - }, { "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": "whether offering allows user driven ad-hoc/scheduled backups", + "name": "allowuserdrivenbackups", + "type": "boolean" + }, + { + "description": "ID of the backup offering", + "name": "id", + "type": "string" + }, + {}, { "description": "provider name", "name": "provider", @@ -57193,11 +57402,7 @@ "name": "description", "type": "string" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } + {} ], "since": "4.14.0" }, @@ -57223,28 +57428,28 @@ } ], "response": [ + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {}, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, - {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - {} + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } ] }, { @@ -57253,11 +57458,12 @@ "name": "migrateVolume", "params": [ { - "description": "if the volume should be live migrated when it is attached to a running vm", + "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, - "name": "livemigrate", + "name": "newdiskofferingid", + "related": "", "required": false, - "type": "boolean" + "type": "uuid" }, { "description": "destination storage pool ID to migrate the volume to", @@ -57268,423 +57474,367 @@ "type": "uuid" }, { - "description": "the ID of the volume", + "description": "if the volume should be live migrated when it is attached to a running vm", "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" + "name": "livemigrate", + "required": false, + "type": "boolean" }, { - "description": "The new disk offering ID that replaces the current one used by the volume. This new disk offering is used to better reflect the new storage where the volume is going to be migrated to.", + "description": "the ID of the volume", "length": 255, - "name": "newdiskofferingid", - "related": "", - "required": false, + "name": "volumeid", + "related": "importVolume,createVolume,updateVolume,listVolumes,migrateVolume,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", + "required": true, "type": "uuid" } ], - "related": "createVolume,updateVolume,listVolumes,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", + "related": "importVolume,createVolume,updateVolume,listVolumes,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", "response": [ { - "description": "ID of the disk volume", - "name": "id", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "the format of the disk encryption if applicable", - "name": "encryptformat", + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "type": "string" }, { - "description": "name of the disk volume", - "name": "name", + "description": "name of the virtual machine", + "name": "vmname", "type": "string" }, - {}, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", - "type": "string" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", - "type": "string" + "description": "details for the volume check result, they may vary for different hypervisors", + "name": "volumecheckresult", + "type": "map" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "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", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "name of the disk volume", + "name": "name", "type": "string" }, { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "cluster name where the volume is allocated", + "name": "clustername", "type": "string" }, + { + "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", + "name": "deviceid", + "type": "long" + }, { "description": "the project id of the vpn", "name": "projectid", "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": "shared or local storage", - "name": "storagetype", + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", - "type": "boolean" - }, - { - "description": "details for the volume check result, they may vary for different hypervisors", - "name": "volumecheckresult", - "type": "map" - }, - { - "description": "state of the virtual machine", - "name": "vmstate", + "description": "the disk utilization", + "name": "utilization", "type": "string" }, { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", - "type": "long" - }, - { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" - }, - { - "description": "the chain info of the volume", - "name": "chaininfo", + "description": "the status of the volume", + "name": "status", "type": "string" }, { - "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": "the read (IO) of disk on the vm", - "name": "diskioread", + "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": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", - "type": "boolean" + "description": "the date the disk volume was created", + "name": "created", + "type": "date" }, { - "description": "size of the disk volume", - "name": "size", + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", "type": "long" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "path of the Domain the disk volume belongs to", + "name": "domainpath", "type": "string" }, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", - "type": "long" - }, - { - "description": "the status of the volume", - "name": "status", + "description": "the state of the disk volume", + "name": "state", "type": "string" }, { - "description": "pod id of the volume", - "name": "podid", + "description": "display name of the virtual machine", + "name": "vmdisplayname", "type": "string" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": "ID of the disk volume", + "name": "id", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the chain info of the volume", + "name": "chaininfo", "type": "string" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "the path of the volume", + "name": "path", "type": "string" }, { - "description": "name of the availability zone", - "name": "zonename", - "type": "string" + "description": "size of the disk volume", + "name": "size", + "type": "long" }, - {}, { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", - "type": "string" + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", + "type": "boolean" }, { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", "type": "string" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the path of the volume", - "name": "path", + "description": "cluster id of the volume", + "name": "clusterid", "type": "string" }, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" - }, - { - "description": "the bytes allocated", - "name": "virtualsize", + "description": "the bytes actually consumed on disk", + "name": "physicalsize", "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": "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": "provisioning type used to create volumes.", - "name": "provisioningtype", - "type": "string" - }, - { - "description": "the account associated with the disk volume", - "name": "account", + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", + "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": "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": "true if the volume is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", + "type": "long" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "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": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", "type": "long" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "type of the virtual machine", + "name": "vmtype", "type": "string" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", - "type": "string" + "description": "true if volume has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, { - "description": "path of the Domain the disk volume belongs to", - "name": "domainpath", - "type": "string" + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", + "type": "boolean" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "the format of the disk encryption if applicable", + "name": "encryptformat", + "type": "string" }, { - "description": "the bytes actually consumed on disk", - "name": "physicalsize", + "description": "max iops of the disk volume", + "name": "maxiops", "type": "long" }, { - "description": "pod name of the volume", - "name": "podname", + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "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 disk offering", - "name": "diskofferingid", + "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 date the volume was attached to a VM instance", + "name": "attached", + "type": "date" }, { - "description": "the disk utilization", - "name": "utilization", + "description": "pod id of the volume", + "name": "podid", "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 VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, { - "description": "max iops of the disk volume", - "name": "maxiops", - "type": "long" + "description": "pod name of the volume", + "name": "podname", + "type": "string" }, { - "description": "the state of the disk volume", - "name": "state", + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", "type": "string" }, { - "description": "type of the virtual machine", - "name": "vmtype", + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", + "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": "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": "id of the resource", - "name": "resourceid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the 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": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -57698,8 +57848,8 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -57709,6 +57859,61 @@ } ], "type": "set" + }, + { + "description": "details for the volume repair result, they may vary for different hypervisors", + "name": "volumerepairresult", + "type": "map" + }, + { + "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", + "type": "string" + }, + { + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", + "type": "string" + }, + { + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" + }, + { + "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": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "shared or local storage", + "name": "storagetype", + "type": "string" + }, + { + "description": "id of the virtual machine", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", + "type": "string" } ], "since": "3.0.0" @@ -57736,49 +57941,104 @@ ], "related": "", "response": [ + { + "description": "Tungsten-Fabric policy name", + "name": "name", + "type": "string" + }, { "description": "Tungsten-Fabric application policy uuid", "name": "uuid", "type": "string" }, - {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "list Tungsten-Fabric tag", + "name": "tag", + "type": "list" + }, { "description": "Tungsten-Fabric provider zone id", "name": "zoneid", "type": "long" }, + { + "description": "list Tungsten-Fabric firewall policy", + "name": "firewallpolicy", + "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", "type": "string" + } + ] + }, + { + "description": "Lists HA providers", + "isasync": false, + "name": "listHostHAProviders", + "params": [ + { + "description": "Hypervisor type of the resource", + "length": 255, + "name": "hypervisor", + "required": true, + "type": "string" + } + ], + "related": "configureHAForHost,enableHAForHost,disableHAForHost", + "response": [ + { + "description": "the HA state of the host", + "name": "hastate", + "type": "hastate" }, + {}, { - "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": "list Tungsten-Fabric firewall policy", - "name": "firewallpolicy", - "type": "list" + "description": "the host HA provider", + "name": "haprovider", + "type": "string" }, + {}, { - "description": "list Tungsten-Fabric tag", - "name": "tag", - "type": "list" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "Tungsten-Fabric policy name", - "name": "name", + "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": "if host HA is enabled for the host", + "name": "haenable", + "type": "boolean" + }, + { + "description": "operation status", + "name": "status", + "type": "boolean" } - ] + ], + "since": "4.11" }, { "description": "Deletes an existing Bgp Peer.", @@ -57795,28 +58055,28 @@ } ], "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, {}, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {} + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + } ], "since": "4.20.0" }, @@ -57826,40 +58086,9 @@ "name": "listEvents", "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": "true to list archived events otherwise false", - "length": 255, - "name": "archived", - "required": false, - "since": "4.19.0", - "type": "boolean" - }, - { - "description": "the start date range of the list you want to retrieve (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-dd HH:mm:ss\")", - "length": 255, - "name": "startdate", - "required": false, - "type": "date" - }, - { - "description": "the ID of the resource associated with the event", - "length": 255, - "name": "resourceid", - "required": false, - "since": "4.17.0", - "type": "string" - }, - { - "description": "the event level (INFO, WARN, ERROR)", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "level", + "name": "account", "required": false, "type": "string" }, @@ -57879,37 +58108,38 @@ "type": "string" }, { - "description": "", + "description": "the duration of the event", "length": 255, - "name": "page", + "name": "duration", "required": false, "type": "integer" }, { - "description": "the time the event was entered", + "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": "entrytime", + "name": "enddate", "required": false, - "type": "integer" + "type": "date" }, { - "description": "the event type (see event types)", + "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": "type", + "name": "startdate", "required": false, - "type": "string" + "type": "date" }, { - "description": "", + "description": "the parent/start ID of the event, when provided this will list all the events with the start/parent ID including the parent event", "length": 255, - "name": "pagesize", + "name": "startid", + "related": "listEvents", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "the type of the resource associated with the event", + "description": "the ID of the resource associated with the event", "length": 255, - "name": "resourcetype", + "name": "resourceid", "required": false, "since": "4.17.0", "type": "string" @@ -57922,27 +58152,27 @@ "type": "boolean" }, { - "description": "The state of the events", + "description": "true to list archived events otherwise false", "length": 255, - "name": "state", + "name": "archived", "required": false, - "since": "4.21.0", - "type": "string" + "since": "4.19.0", + "type": "boolean" }, { - "description": "the parent/start ID of the event, when provided this will list all the events with the start/parent ID including the parent event", + "description": "the time the event was entered", "length": 255, - "name": "startid", - "related": "listEvents", + "name": "entrytime", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "account", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, - "type": "string" + "type": "uuid" }, { "description": "the ID of the event", @@ -57953,11 +58183,25 @@ "type": "uuid" }, { - "description": "the end date range of the list you want to retrieve (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-dd HH:mm:ss\")", + "description": "the event level (INFO, WARN, ERROR)", "length": 255, - "name": "enddate", + "name": "level", "required": false, - "type": "date" + "type": "string" + }, + { + "description": "the event type (see event types)", + "length": 255, + "name": "type", + "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.", @@ -57967,49 +58211,54 @@ "type": "boolean" }, { - "description": "the duration of the event", + "description": "", "length": 255, - "name": "duration", + "name": "pagesize", "required": false, "type": "integer" - } - ], - "related": "", - "response": [ + }, { - "description": "the type of the event (see event types)", - "name": "type", + "description": "the type of the resource associated with the event", + "length": 255, + "name": "resourcetype", + "required": false, + "since": "4.17.0", "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "The state of the events", + "length": 255, + "name": "state", + "required": false, + "since": "4.21.0", "type": "string" - }, + } + ], + "related": "", + "response": [ { - "description": "the type of the resource", - "name": "resourcetype", + "description": "the id of the account's domain", + "name": "domainid", "type": "string" }, { - "description": "whether the event is parented", - "name": "parentid", + "description": "the event level (INFO, WARN, ERROR)", + "name": "level", "type": "string" }, - {}, { - "description": "the name of the account's domain", - "name": "domain", + "description": "a brief description of the event", + "name": "description", "type": "string" }, { - "description": "the date the event was created", - "name": "created", - "type": "date" + "description": "whether the event has been archived or not", + "name": "archived", + "type": "boolean" }, { - "description": "the event level (INFO, WARN, ERROR)", - "name": "level", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -58018,49 +58267,38 @@ "type": "string" }, { - "description": "path of the Domain the account's domain belongs to", - "name": "domainpath", + "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 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": "a brief description of the event", - "name": "description", + "description": "the type of the event (see event types)", + "name": "type", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the id of the account's domain", - "name": "domainid", + "description": "the type of the resource", + "name": "resourcetype", "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 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": "path of the Domain the account's domain belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the ID of the event", - "name": "id", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { @@ -58069,71 +58307,38 @@ "type": "string" }, { - "description": "the state of the event", - "name": "state", - "type": "state" + "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": "Lists HA providers", - "isasync": false, - "name": "listHostHAProviders", - "params": [ - { - "description": "Hypervisor type of the resource", - "length": 255, - "name": "hypervisor", - "required": true, - "type": "string" - } - ], - "related": "configureHAForHost,enableHAForHost,disableHAForHost", - "response": [ - { - "description": "the host HA provider", - "name": "haprovider", - "type": "string" + "description": "the date the event was created", + "name": "created", + "type": "date" }, {}, { - "description": "operation status", - "name": "status", - "type": "boolean" + "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 ID of the host", - "name": "hostid", + "description": "whether the event is parented", + "name": "parentid", "type": "string" }, { - "description": "if host HA is enabled for the host", - "name": "haenable", - "type": "boolean" + "description": "the state of the event", + "name": "state", + "type": "state" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the account's domain", + "name": "domain", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the HA state of the host", - "name": "hastate", - "type": "hastate" - } - ], - "since": "4.11" + {} + ] }, { "description": "Creates resource tag(s)", @@ -58147,13 +58352,6 @@ "required": true, "type": "string" }, - { - "description": "identifies client specific tag. When the value is not null, the tag can't be used by cloudStack code internally", - "length": 255, - "name": "customer", - "required": false, - "type": "string" - }, { "description": "list of resources to create the tags for", "length": 255, @@ -58167,6 +58365,13 @@ "name": "tags", "required": true, "type": "map" + }, + { + "description": "identifies client specific tag. When the value is not null, the tag can't be used by cloudStack code internally", + "length": 255, + "name": "customer", + "required": false, + "type": "string" } ], "response": [ @@ -58175,23 +58380,23 @@ "name": "jobstatus", "type": "integer" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, + {}, + {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, - {} + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + } ], "since": "4.0.0" }, @@ -58204,7 +58409,7 @@ "description": "the network service provider ID of the internal load balancer element", "length": 255, "name": "nspid", - "related": "addNetworkServiceProvider,listNetworkServiceProviders,listTrafficTypes", + "related": "addNetworkServiceProvider,listNetworkServiceProviders", "required": true, "type": "uuid" } @@ -58218,8 +58423,8 @@ }, {}, { - "description": "the id of the internal load balancer element", - "name": "id", + "description": "the physical network service provider id of the element", + "name": "nspid", "type": "string" }, { @@ -58232,12 +58437,12 @@ "name": "enabled", "type": "boolean" }, + {}, { - "description": "the physical network service provider id of the element", - "name": "nspid", + "description": "the id of the internal load balancer element", + "name": "id", "type": "string" - }, - {} + } ], "since": "4.2.0" }, @@ -58256,28 +58461,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": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - {} + } ] }, { @@ -58295,28 +58500,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": "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" + }, + {} ] }, { @@ -58324,6 +58529,13 @@ "isasync": true, "name": "generateAlert", "params": [ + { + "description": "Alert description", + "length": 999, + "name": "description", + "required": true, + "type": "string" + }, { "description": "Type of the alert", "length": 255, @@ -58353,13 +58565,6 @@ "name": "name", "required": true, "type": "string" - }, - { - "description": "Alert description", - "length": 999, - "name": "description", - "required": true, - "type": "string" } ], "response": [ @@ -58369,22 +58574,22 @@ "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 UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - } + }, + {} ], "since": "4.3" }, @@ -58394,98 +58599,87 @@ "name": "ldapConfig", "params": [ { - "description": "The search base defines the starting point for the search in the directory tree Example: dc=cloud,dc=com.", + "description": "Specify the distinguished name of a user with the search permission on the directory.", "length": 255, - "name": "searchbase", + "name": "binddn", "required": false, "type": "string" }, { - "description": "Specify the distinguished name of a user with the search permission on the directory.", + "description": "Specify the LDAP port if required, default is 389.", "length": 255, - "name": "binddn", + "name": "port", "required": false, - "type": "string" + "type": "integer" }, { - "description": "If true return current LDAP configuration", + "description": "Enter the path to trust certificates store.", "length": 255, - "name": "listall", + "name": "truststore", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "Hostname or ip address of the ldap server eg: my.ldap.com", + "description": "Check Use SSL if the external LDAP server is configured for LDAP over SSL.", "length": 255, - "name": "hostname", + "name": "ssl", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "Enter the password.", + "description": "Enter the password for trust store.", "length": 255, - "name": "bindpass", + "name": "truststorepass", "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": "You specify a query filter here, which narrows down the users, who can be part of this domain.", "length": 255, - "name": "truststore", + "name": "queryfilter", "required": false, "type": "string" }, { - "description": "You specify a query filter here, which narrows down the users, who can be part of this domain.", + "description": "The search base defines the starting point for the search in the directory tree Example: dc=cloud,dc=com.", "length": 255, - "name": "queryfilter", + "name": "searchbase", "required": false, "type": "string" }, { - "description": "Specify the LDAP port if required, default is 389.", + "description": "Enter the password.", "length": 255, - "name": "port", + "name": "bindpass", "required": false, - "type": "integer" + "type": "string" }, { - "description": "Enter the password for trust store.", + "description": "Hostname or ip address of the ldap server eg: my.ldap.com", "length": 255, - "name": "truststorepass", + "name": "hostname", "required": false, "type": "string" } ], "related": "ldapRemove", "response": [ - { - "description": "Specify the distinguished name of a user with the search permission on the directory", - "name": "binddn", - "type": "string" - }, {}, - { - "description": "Hostname or ip address of the ldap server eg: my.ldap.com", - "name": "hostname", - "type": "string" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, { - "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" }, { @@ -58493,19 +58687,30 @@ "name": "ssl", "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": "You specify a query filter here, which narrows down the users, who can be part of this domain", + "name": "queryfilter", + "type": "string" + }, + {}, { "description": "Specify the LDAP port if required, default is 389", "name": "port", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Hostname or ip address of the ldap server eg: my.ldap.com", + "name": "hostname", "type": "string" }, { - "description": "The search base defines the starting point for the search in the directory tree Example: dc=cloud,dc=com", - "name": "searchbase", + "description": "Specify the distinguished name of a user with the search permission on the directory", + "name": "binddn", "type": "string" }, { @@ -58533,20 +58738,25 @@ "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": "the identifier of the Storage Policy in vSphere DataCenter", + "name": "policyid", "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", + "description": "the ID of the Zone", + "name": "zoneid", "type": "string" }, { @@ -58560,14 +58770,9 @@ "type": "string" }, { - "description": "the ID of the Zone", - "name": "zoneid", + "description": "the UUID of the latest async 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" } ] }, @@ -58580,24 +58785,24 @@ "description": "the ID of the port forwarding rule", "length": 255, "name": "id", - "related": "createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,updateIpv6FirewallRule", + "related": "createRoutingFirewallRule,listRoutingFirewallRules,updateIpv6FirewallRule,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule", "required": true, "type": "uuid" } ], "response": [ + {}, + {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, { "description": "true if operation is executed successfully", "name": "success", @@ -58616,18 +58821,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", - "length": 255, - "name": "tiernetworkofferings", - "required": false, - "type": "map" - }, - { - "description": "true if previous network migration cmd failed", + "description": "vpc offering ID", "length": 255, - "name": "resume", - "required": false, - "type": "boolean" + "name": "vpcofferingid", + "related": "updateVPCOffering,listVPCOfferings", + "required": true, + "type": "uuid" }, { "description": "the ID of the vpc", @@ -58638,102 +58837,27 @@ "type": "uuid" }, { - "description": "vpc offering ID", + "description": "true if previous network migration cmd failed", "length": 255, - "name": "vpcofferingid", - "related": "updateVPCOffering,listVPCOfferings", - "required": true, - "type": "uuid" + "name": "resume", + "required": false, + "type": "boolean" + }, + { + "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 id of the VPC", - "name": "id", - "type": "string" - }, - { - "description": "the domain id of the VPC owner", - "name": "domainid", - "type": "string" - }, - { - "description": "the owner of the VPC", - "name": "account", - "type": "string" - }, - {}, - { - "description": "the name of the VPC", - "name": "name", - "type": "string" - }, - { - "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": "an alternate display text of the VPC.", - "name": "displaytext", - "type": "string" - }, - { - "description": "vpc offering id the VPC is created from", - "name": "vpcofferingid", - "type": "string" - }, - { - "description": "the cidr the VPC", - "name": "cidr", - "type": "string" - }, - { - "description": "the domain path of the owner", - "name": "domainpath", - "type": "string" - }, - { - "description": "is vpc for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the list of networks belongign to the VPC", - "name": "network", - "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": "true VPC requires restart", - "name": "restartrequired", - "type": "boolean" - }, - { - "description": "zone id of the vpc", - "name": "zoneid", - "type": "string" - }, { "description": "the list of supported services", "name": "service", @@ -58753,8 +58877,8 @@ "type": "string" }, { - "description": "uuid of the network provider", - "name": "id", + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", "type": "string" }, { @@ -58763,13 +58887,13 @@ "type": "list" }, { - "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": "uuid of the network provider", + "name": "id", "type": "string" }, { @@ -58780,15 +58904,15 @@ ], "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 name", "name": "name", @@ -58798,27 +58922,93 @@ "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" } ], "type": "list" }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "true VPC requires restart", + "name": "restartrequired", + "type": "boolean" + }, + { + "description": "the project id of the VPC", + "name": "projectid", + "type": "string" + }, + { + "description": "true if VPC is region level", + "name": "regionlevelvpc", + "type": "boolean" + }, + { + "description": "the network domain of the VPC", + "name": "networkdomain", + "type": "string" + }, + { + "description": "the domain path of the owner", + "name": "domainpath", + "type": "string" + }, { "description": "the date this VPC was created", "name": "created", "type": "date" }, { - "description": "MTU configured on the public interfaces of the VPC VR", - "name": "publicmtu", - "type": "integer" + "description": "UUID of AS NUMBER", + "name": "asnumberid", + "type": "string" + }, + { + "description": "the list of networks belongign to the VPC", + "name": "network", + "type": "list" + }, + { + "description": "is VPC uses distributed router for one hop forwarding and host based network ACL's", + "name": "distributedvpcrouter", + "type": "boolean" + }, + { + "description": "the name of the zone the VPC belongs to", + "name": "zonename", + "type": "string" + }, + {}, + { + "description": "AS NUMBER", + "name": "asnumber", + "type": "long" + }, + { + "description": "the id of the VPC", + "name": "id", + "type": "string" + }, + { + "description": "the domain name of the owner", + "name": "domain", + "type": "string" + }, + { + "description": "the second IPv4 DNS for the VPC", + "name": "dns2", + "type": "string" }, { "description": "the first IPv6 DNS for the VPC", @@ -58826,14 +59016,33 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "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": "an alternate display text of the VPC.", + "name": "displaytext", "type": "string" }, - {}, { - "description": "the network domain of the VPC", - "name": "networkdomain", + "description": "the cidr the VPC", + "name": "cidr", + "type": "string" + }, + { + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" + }, + { + "description": "the second IPv6 DNS for the VPC", + "name": "ip6dns2", "type": "string" }, { @@ -58841,23 +59050,43 @@ "name": "ip4routing", "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": "the project name of the VPC", + "name": "project", + "type": "string" + }, + { + "description": "vpc offering id the VPC is created from", + "name": "vpcofferingid", + "type": "string" + }, { "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" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -58866,117 +59095,93 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "id of the resource", + "name": "resourceid", "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": "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": "id of the resource", - "name": "resourceid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], "type": "list" }, - { - "description": "the first IPv4 DNS for the VPC", - "name": "dns1", - "type": "string" - }, - { - "description": "The BGP peers for the VPC", - "name": "bgppeers", - "type": "set" - }, - { - "description": "UUID of AS NUMBER", - "name": "asnumberid", - "type": "string" - }, - { - "description": "vpc offering name the VPC is created from", - "name": "vpcofferingname", - "type": "string" - }, { "description": "if this VPC has redundant router", "name": "redundantvpcrouter", "type": "boolean" }, { - "description": "the project name of the VPC", - "name": "project", + "description": "the name of the VPC", + "name": "name", "type": "string" }, { - "description": "true if VPC is region level", - "name": "regionlevelvpc", - "type": "boolean" + "description": "the owner of the VPC", + "name": "account", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "MTU configured on the public interfaces of the VPC VR", + "name": "publicmtu", + "type": "integer" }, { - "description": "the project id of the VPC", - "name": "projectid", + "description": "the UUID of the latest async 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": "zone id of the vpc", + "name": "zoneid", + "type": "string" }, { - "description": "the name of the zone the VPC belongs to", - "name": "zonename", + "description": "the first IPv4 DNS for the VPC", + "name": "dns1", "type": "string" }, + {}, { - "description": "is VPC uses distributed router for one hop forwarding and host based network ACL's", - "name": "distributedvpcrouter", + "description": "is vpc for display to the regular user", + "name": "fordisplay", "type": "boolean" }, { - "description": "the domain name of the owner", - "name": "domain", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip6routes", + "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" } ], "since": "4.11.0" @@ -58996,28 +59201,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": "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" - } + {} ] }, { @@ -59042,56 +59247,102 @@ ], "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 user that entered the annotation", + "name": "userid", + "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 username of the user that entered the annotation", + "name": "username", + "type": "string" }, { - "description": "the type of the annotated entity", - "name": "entitytype", + "description": "the (uu)id of the entity to which this annotation pertains", + "name": "entityid", "type": "string" }, + { + "description": "True if the annotation is available for admins only", + "name": "adminsonly", + "type": "boolean" + }, { "description": "the name of the entity to which this annotation pertains", "name": "entityname", "type": "string" }, + {}, { - "description": "the (uu)id of the entity to which this annotation pertains", - "name": "entityid", + "description": "the creation timestamp for this annotation", + "name": "created", + "type": "date" + }, + { + "description": "the type of the annotated entity", + "name": "entitytype", "type": "string" }, - {}, { "description": "the removal timestamp for this annotation", "name": "removed", "type": "date" }, { - "description": "the creation timestamp for this annotation", - "name": "created", - "type": "date" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { - "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" + } + ], + "since": "4.16" + }, + { + "description": "Configures HA for a host", + "isasync": true, + "name": "configureHAForHost", + "params": [ + { + "description": "ID of the host", + "length": 255, + "name": "hostid", + "related": "addBaremetalHost,cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost", + "required": true, + "type": "uuid" + }, + { + "description": "HA provider", + "length": 255, + "name": "provider", + "required": true, + "type": "string" + } + ], + "related": "enableHAForHost,disableHAForHost", + "response": [ + { + "description": "operation status", + "name": "status", + "type": "boolean" + }, + { + "description": "the ID of the host", + "name": "hostid", "type": "string" }, { @@ -59100,12 +59351,29 @@ "type": "string" }, { - "description": "The username of the user that entered the annotation", - "name": "username", + "description": "the HA state of the host", + "name": "hastate", + "type": "hastate" + }, + { + "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 host HA provider", + "name": "haprovider", "type": "string" - } + }, + {} ], - "since": "4.16" + "since": "4.11" }, { "description": "Updates a configuration.", @@ -59113,20 +59381,28 @@ "name": "updateConfiguration", "params": [ { - "description": "the ID of the Image Store to update the parameter value for corresponding image store", + "description": "the ID of the Storage pool to update the parameter value for corresponding storage pool", "length": 255, - "name": "imagestoreuuid", - "related": "addSecondaryStorage,addSwift,listSwifts,addImageStore,addImageStoreS3,listImageStores", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", "required": false, "type": "uuid" }, { - "description": "the name of the configuration", - "length": 255, - "name": "name", - "required": true, + "description": "the value of the configuration", + "length": 4096, + "name": "value", + "required": false, "type": "string" }, + { + "description": "the ID of the Image Store to update the parameter value for corresponding image store", + "length": 255, + "name": "imagestoreuuid", + "related": "addSecondaryStorage,addSwift,listSwifts,addImageStore,addImageStoreS3,listImageStores", + "required": false, + "type": "uuid" + }, { "description": "the ID of the Domain to update the parameter value for corresponding domain", "length": 255, @@ -59136,12 +59412,11 @@ "type": "uuid" }, { - "description": "the ID of the Storage pool to update the parameter value for corresponding storage pool", + "description": "the name of the configuration", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", - "required": false, - "type": "uuid" + "name": "name", + "required": true, + "type": "string" }, { "description": "the ID of the Cluster to update the parameter value for corresponding cluster", @@ -59166,45 +59441,39 @@ "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", - "type": "string" - }, { "description": "the value of the configuration", "name": "value", "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 name of the parent configuration", + "name": "parent", + "type": "string" + }, + {}, { "description": "the description of the configuration", "name": "description", "type": "string" }, { - "description": "the name of the configuration", - "name": "name", + "description": "the component of the configuration", + "name": "component", + "type": "string" + }, + { + "description": "the subgroup of the configuration", + "name": "subgroup", "type": "string" }, { @@ -59212,15 +59481,14 @@ "name": "id", "type": "long" }, - {}, { - "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": "the group of the configuration", - "name": "group", + "description": "the name of the configuration", + "name": "name", "type": "string" }, { @@ -59229,8 +59497,8 @@ "type": "string" }, { - "description": "the subgroup of the configuration", - "name": "subgroup", + "description": "the category of the configuration", + "name": "category", "type": "string" }, { @@ -59239,107 +59507,52 @@ "type": "string" }, { - "description": "the type of the configuration value", - "name": "type", - "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", + "description": "the group of the configuration", + "name": "group", "type": "string" }, { - "description": "the display text of the configuration", - "name": "displaytext", + "description": "the default value of the configuration", + "name": "defaultvalue", "type": "string" }, { - "description": "the component of the configuration", - "name": "component", + "description": "the display text of the configuration", + "name": "displaytext", "type": "string" }, {}, { - "description": "the name of the parent configuration", - "name": "parent", + "description": "the type of the configuration value", + "name": "type", "type": "string" } ] }, { - "description": "Configures HA for a host", - "isasync": true, - "name": "configureHAForHost", + "description": "Lists volume stats", + "isasync": false, + "name": "listVolumesUsageHistory", "params": [ { - "description": "ID of the host", - "length": 255, - "name": "hostid", - "related": "cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost,addBaremetalHost", - "required": true, - "type": "uuid" - }, - { - "description": "HA provider", + "description": "List by keyword", "length": 255, - "name": "provider", - "required": true, - "type": "string" - } - ], - "related": "enableHAForHost,disableHAForHost", - "response": [ - { - "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": "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", + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the HA state of the host", - "name": "hastate", - "type": "hastate" - }, - {} - ], - "since": "4.11" - }, - { - "description": "Lists volume stats", - "isasync": false, - "name": "listVolumesUsageHistory", - "params": [ - { - "description": "start date to filter stats.Use format \"yyyy-MM-dd hh:mm:ss\")", + "description": "the ID of the volume.", "length": 255, - "name": "startdate", + "name": "id", + "related": "importVolume,createVolume,updateVolume,listVolumes,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", "required": false, - "type": "date" + "type": "uuid" }, { "description": "the IDs of the volumes, mutually exclusive with id.", @@ -59349,13 +59562,6 @@ "required": false, "type": "list" }, - { - "description": "", - "length": 255, - "name": "pagesize", - "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).", "length": 255, @@ -59364,24 +59570,23 @@ "type": "string" }, { - "description": "the ID of the volume.", + "description": "end date to filter stats.Use format \"yyyy-MM-dd hh:mm:ss\")", "length": 255, - "name": "id", - "related": "createVolume,updateVolume,listVolumes,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", + "name": "enddate", "required": false, - "type": "uuid" + "type": "date" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "end date to filter stats.Use format \"yyyy-MM-dd hh:mm:ss\")", + "description": "start date to filter stats.Use format \"yyyy-MM-dd hh:mm:ss\")", "length": 255, - "name": "enddate", + "name": "startdate", "required": false, "type": "date" }, @@ -59401,8 +59606,8 @@ "type": "list" }, { - "description": "the ID of the volume", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -59410,18 +59615,18 @@ "name": "jobstatus", "type": "integer" }, + {}, { - "description": "the name of the volume", - "name": "name", + "description": "the ID of the volume", + "name": "id", "type": "string" }, - {}, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the volume", + "name": "name", "type": "string" - } + }, + {} ], "since": "4.18.0" }, @@ -59431,88 +59636,77 @@ "name": "dedicatePublicIpRange", "params": [ { - "description": "project who will own the VLAN", + "description": "account who will own the VLAN", "length": 255, - "name": "projectid", - "related": "activateProject,createProject,suspendProject", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "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" }, { - "description": "account who will own the VLAN", + "description": "project who will own the VLAN", "length": 255, - "name": "account", + "name": "projectid", + "related": "activateProject,createProject,suspendProject", "required": false, - "type": "string" + "type": "uuid" } ], "related": "createVlanIpRange,updateVlanIpRange", "response": [ { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the account of the VLAN IP range", + "name": "account", "type": "string" }, { - "description": "indicates whether VLAN IP range is dedicated to system vms or not", - "name": "forsystemvms", - "type": "boolean" + "description": "the start ipv6 of the VLAN IP range", + "name": "startipv6", + "type": "string" }, { "description": "the cidr of the VLAN IP range", "name": "cidr", "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 UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the Pod name for the VLAN IP range", - "name": "podname", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "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 domain name of the VLAN IP range", - "name": "domain", + "description": "the start ip of the VLAN IP range", + "name": "startip", "type": "string" }, { - "description": "the end ipv6 of the VLAN IP range", - "name": "endipv6", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { @@ -59526,8 +59720,8 @@ "type": "string" }, { - "description": "the netmask of the VLAN IP range", - "name": "netmask", + "description": "indicates to which provider the IP range is dedicated to", + "name": "provider", "type": "string" }, { @@ -59535,11 +59729,6 @@ "name": "networkid", "type": "string" }, - { - "description": "the project id of the vlan range", - "name": "projectid", - "type": "string" - }, { "description": "the Pod ID for the VLAN IP range", "name": "podid", @@ -59551,102 +59740,78 @@ "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 description of the VLAN IP range", - "name": "description", + "description": "the domain name of the VLAN IP range", + "name": "domain", "type": "string" }, { - "description": "the start ipv6 of the VLAN IP range", - "name": "startipv6", + "description": "path of the domain to which the VLAN IP range belongs", + "name": "domainpath", "type": "string" }, { - "description": "the start ip of the VLAN IP range", - "name": "startip", + "description": "the netmask of the VLAN IP range", + "name": "netmask", "type": "string" }, + {}, { - "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 description of the VLAN IP range", + "name": "description", "type": "string" }, {}, { - "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 virtual network for the VLAN IP range", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "the ID of the VLAN IP range", - "name": "id", + "description": "the project id of the vlan range", + "name": "projectid", "type": "string" }, { - "description": "the project name of the vlan range", - "name": "project", - "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", - "type": "string" - } - ] - }, - { - "description": "Deletes an empty Bucket.", - "isasync": false, - "name": "deleteBucket", - "params": [ - { - "description": "The ID of the Bucket", - "length": 255, - "name": "id", - "related": "createBucket,listBuckets", - "required": true, - "type": "uuid" - } - ], - "response": [ - {}, - { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the end ip of the VLAN IP range", + "name": "endip", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the gateway of the VLAN IP range", + "name": "gateway", "type": "string" }, - {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the project name of the vlan range", + "name": "project", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the Pod name for the VLAN IP range", + "name": "podname", + "type": "string" } - ], - "since": "4.19.0" + ] }, { "description": "Adds API permissions to a project role", @@ -59661,11 +59826,12 @@ "type": "string" }, { - "description": "The API name or wildcard rule such as list*", + "description": "ID of project where project role permission is to be created", "length": 255, - "name": "rule", + "name": "projectid", + "related": "activateProject,createProject,suspendProject", "required": true, - "type": "string" + "type": "uuid" }, { "description": "ID of the project role", @@ -59683,47 +59849,51 @@ "type": "string" }, { - "description": "ID of project where project role permission is to be created", + "description": "The API name or wildcard rule such as list*", "length": 255, - "name": "projectid", - "related": "activateProject,createProject,suspendProject", + "name": "rule", "required": true, - "type": "uuid" + "type": "string" } ], "related": "listProjectRolePermissions", "response": [ { - "description": "the ID of the project", - "name": "projectid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the description of the role permission", + "name": "description", "type": "string" }, { - "description": "the ID of the project role permission", - "name": "id", + "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", + "description": "the ID of the project role permission", + "name": "id", "type": "string" }, + {}, { "description": "the name of the project role to which the role permission belongs", "name": "projectrolename", "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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the api name or wildcard rule", + "name": "rule", + "type": "string" }, { "description": "the ID of the project role to which the role permission belongs", @@ -59731,49 +59901,84 @@ "type": "string" }, { - "description": "the api name or wildcard rule", - "name": "rule", - "type": "string" - }, - { - "description": "the permission type of the api name or wildcard rule, allow/deny", - "name": "permission", + "description": "the ID of the project", + "name": "projectid", "type": "string" } ], "since": "4.15.0" }, { - "description": "Create a console endpoint to connect to a VM console", + "description": "Deletes an empty Bucket.", "isasync": false, - "name": "createConsoleEndpoint", + "name": "deleteBucket", "params": [ { - "description": "(optional) extra security token, valid when the extra validation is enabled", + "description": "The ID of the Bucket", "length": 255, - "name": "token", - "required": false, + "name": "id", + "related": "createBucket,listBuckets", + "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": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + } + ], + "since": "4.19.0" + }, + { + "description": "Create a console endpoint to connect to a VM console", + "isasync": false, + "name": "createConsoleEndpoint", + "params": [ { "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,createVMFromBackup,createVMFromBackup,assignVirtualMachine,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", "required": true, "type": "uuid" + }, + { + "description": "(optional) extra security token, valid when the extra validation is enabled", + "length": 255, + "name": "token", + "required": false, + "type": "string" } ], "related": "", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the console websocket options", + "name": "websocket", + "type": "consoleendpointwebsocketresponse" }, { - "description": "the console url", - "name": "url", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, {}, @@ -59783,9 +59988,9 @@ "type": "integer" }, { - "description": "the console websocket options", - "name": "websocket", - "type": "consoleendpointwebsocketresponse" + "description": "the console url", + "name": "url", + "type": "string" }, { "description": "details in case of an error", @@ -59807,19 +60012,20 @@ "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", + "description": "ID of project where project role permission is to be updated", "length": 255, - "name": "permission", - "required": false, - "type": "string" + "name": "projectid", + "related": "activateProject,createProject,suspendProject", + "required": true, + "type": "uuid" }, { "description": "Project Role permission rule id", @@ -59830,44 +60036,43 @@ "type": "uuid" }, { - "description": "The parent role permission uuid, use 0 to move this rule at the top of the list", + "description": "Rule permission, can be: allow or deny", "length": 255, - "name": "ruleorder", - "related": "listProjectRolePermissions", + "name": "permission", "required": false, - "type": "list" + "type": "string" }, { - "description": "ID of project where project role permission is to be updated", + "description": "ID of the project role", "length": 255, - "name": "projectid", - "related": "activateProject,createProject,suspendProject", + "name": "projectroleid", + "related": "listProjectRoles,updateProjectRole", "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", + "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" } ], "since": "4.15.0" @@ -59878,19 +60083,12 @@ "name": "addUserToProject", "params": [ { - "description": "ID of the project to add the user to", - "length": 255, - "name": "projectid", - "related": "activateProject,createProject,suspendProject", - "required": true, - "type": "uuid" - }, - { - "description": "Project role type to be assigned to the user - Admin/Regular", + "description": "ID of the project role", "length": 255, - "name": "roletype", + "name": "projectroleid", + "related": "listProjectRoles,updateProjectRole", "required": false, - "type": "string" + "type": "uuid" }, { "description": "email ID of user to which invitation to the project is going to be sent", @@ -59900,11 +60098,11 @@ "type": "string" }, { - "description": "ID of the project role", + "description": "ID of the project to add the user to", "length": 255, - "name": "projectroleid", - "related": "listProjectRoles,updateProjectRole", - "required": false, + "name": "projectid", + "related": "activateProject,createProject,suspendProject", + "required": true, "type": "uuid" }, { @@ -59913,108 +60111,28 @@ "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 UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - {} - ], - "since": "4.14" - }, - { - "description": "Disables HA cluster-wide", - "isasync": true, - "name": "disableHAForCluster", - "params": [ - { - "description": "ID of the cluster", - "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", - "required": true, - "type": "uuid" - } - ], - "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - { - "description": "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.11" - }, - { - "description": "delete Tungsten-Fabric firewall policy", - "isasync": true, - "name": "deleteTungstenFabricFirewallPolicy", - "params": [ { - "description": "the uuid of Tungsten-Fabric firewall policy", + "description": "Project role type to be assigned to the user - Admin/Regular", "length": 255, - "name": "firewallpolicyuuid", - "required": true, + "name": "roletype", + "required": false, "type": "string" - }, - { - "description": "the ID of zone", - "length": 255, - "name": "zoneid", - "related": "createZone,listZones", - "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", @@ -60025,533 +60143,178 @@ "name": "jobstatus", "type": "integer" } - ] + ], + "since": "4.14" }, { - "description": "Recovers a virtual machine.", - "isasync": false, - "name": "recoverVirtualMachine", - "params": [ - { - "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", - "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", - "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", - "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", - "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": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" - }, - { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the project name of the affinity group", - "name": "project", - "type": "string" - }, - { - "description": "the name of the affinity group", - "name": "name", - "type": "string" - }, - { - "description": "the description of the affinity group", - "name": "description", - "type": "string" - }, - { - "description": "the ID of the affinity group", - "name": "id", - "type": "string" - }, - { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" - }, - { - "description": "the type of the affinity group", - "name": "type", - "type": "string" - }, - { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "description": "the project ID of the affinity group", - "name": "projectid", - "type": "string" - }, - { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" - }, - { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", - "type": "list" - } - ], - "type": "set" - }, - { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, - { - "description": "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": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" - }, - { - "description": "State of the Service from LB rule", - "name": "servicestate", - "type": "string" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", - "type": "string" - }, + "description": "Disables HA cluster-wide", + "isasync": true, + "name": "disableHAForCluster", + "params": [ { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "type": "string" - }, + "description": "ID of the cluster", + "length": 255, + "name": "clusterid", + "related": "addCluster,updateCluster", + "required": true, + "type": "uuid" + } + ], + "response": [ { - "description": "the name of the host for the virtual machine", - "name": "hostname", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "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" }, + {}, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {} + ], + "since": "4.11" + }, + { + "description": "delete Tungsten-Fabric firewall policy", + "isasync": true, + "name": "deleteTungstenFabricFirewallPolicy", + "params": [ { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "createZone,listZones", + "required": true, + "type": "uuid" }, { - "description": "the project name of the vm", - "name": "project", + "description": "the uuid of Tungsten-Fabric firewall policy", + "length": 255, + "name": "firewallpolicyuuid", + "required": true, "type": "string" - }, + } + ], + "response": [ { - "description": "the maximum Y resolution", - "name": "maxresolutiony", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "CPU arch of the VM", - "name": "arch", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "the VM's primary IP address", - "name": "ipaddress", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" - }, + } + ] + }, + { + "description": "Recovers a virtual machine.", + "isasync": false, + "name": "recoverVirtualMachine", + "params": [ { - "description": "Os type ID of the virtual machine", - "name": "guestosid", - "type": "string" - }, + "description": "The ID of the virtual machine", + "length": 255, + "name": "id", + "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,createVMFromBackup,createVMFromBackup,assignVirtualMachine,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", + "required": true, + "type": "uuid" + } + ], + "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,createVMFromBackup,createVMFromBackup,assignVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", + "response": [ { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", + "description": "the video RAM size in MB", + "name": "videoram", "type": "long" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", - "type": "string" - }, - { - "description": "OS name of the vm", - "name": "osdisplayname", + "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", - "type": "string" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { "description": "the list of nics associated with vm", "name": "nic", "response": [ { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "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 broadcast uri of the nic", - "name": "broadcasturi", + "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": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the traffic type of the nic", + "name": "traffictype", "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" }, { - "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 Secondary ipv4 addr of nic", - "name": "secondaryip", + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", "type": "list" }, { @@ -60560,375 +60323,193 @@ "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", + "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 type of the nic", + "name": "type", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "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 if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "the netmask of the nic", + "name": "netmask", "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": "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 type of the nic", - "name": "type", + "description": "the ID of the nic", + "name": "id", "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": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "the ip address of the nic", + "name": "ipaddress", "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 gateway of the nic", - "name": "gateway", + "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": "true if nic is default, false otherwise", - "name": "macaddress", + "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": "Type of adapter if available", + "name": "adaptertype", "type": "string" } ], "type": "set" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "User VM type", + "name": "vmtype", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" - }, - { - "description": "Instance lease expiry date", - "name": "leaseexpirydate", - "type": "date" - }, - { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" - }, - { - "description": "the maximum number of display heads", - "name": "maxheads", - "type": "long" - }, - { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "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 date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "description": "the name of the vgpu profile to which service offering is linked", - "name": "vgpuprofilename", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "the ID of the gpu card to which service offering is linked", - "name": "gpucardid", - "type": "string" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "the count of GPUs on the virtual machine", - "name": "gpucount", + "description": "the speed of each vCPU", + "name": "cpuspeed", "type": "integer" }, - { - "description": "Base64 string containing the user data", - "name": "userdata", - "type": "string" - }, - { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" - }, - { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", - "type": "string" - }, - { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" - }, - { - "description": "ssh key-pairs", - "name": "keypairs", - "type": "string" - }, - { - "description": "Guest vm Boot Mode", - "name": "bootmode", - "type": "string" - }, - { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "User VM type", - "name": "vmtype", - "type": "string" - }, - { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" - }, - { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" - }, - { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", - "type": "string" - }, { "description": "list of security groups associated with the virtual machine", "name": "securitygroup", "response": [ { - "description": "the 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": "path of the Domain the security group belongs to", + "name": "domainpath", + "type": "string" }, { - "description": "the description of the security group", - "name": "description", - "type": "string" + "description": "the 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": "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 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", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -60937,13 +60518,8 @@ "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" }, { @@ -60952,13 +60528,13 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -60967,39 +60543,64 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "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 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 type of the ICMP message response", - "name": "icmptype", + "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", "type": "integer" } ], "type": "set" }, { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", + "description": "the project id of the group", + "name": "projectid", "type": "string" }, { @@ -61008,47 +60609,89 @@ "type": "string" }, { - "description": "the domain name of the security group", - "name": "domain", + "description": "the domain ID of the security group", + "name": "domainid", "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 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": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" + "description": "resource type", + "name": "resourcetype", + "type": "string" }, { - "description": "account owning the security group rule", + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the account associated with the tag", "name": "account", "type": "string" }, { - "description": "security group name", - "name": "securitygroupname", + "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" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the 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" }, { @@ -61060,44 +60703,34 @@ "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", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "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" }, { @@ -61109,10 +60742,45 @@ "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" } ], "type": "set" }, + { + "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 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", @@ -61122,56 +60790,498 @@ "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 ID of the security group", + "name": "id", + "type": "string" + }, { "description": "the name of the security group", "name": "name", "type": "string" }, { - "description": "the project id of the group", + "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 list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + } + ], + "type": "set" + }, + { + "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": "the amount of the vm's CPU currently used", + "name": "cpuused", + "type": "string" + }, + {}, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the 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": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" + }, + { + "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": "the project id of the vm", + "name": "projectid", + "type": "string" + }, + { + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" + }, + { + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, + { + "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": "Guest vm Boot Type", + "name": "boottype", + "type": "string" + }, + { + "description": "the ID of the virtual machine", + "name": "id", + "type": "string" + }, + { + "description": "the maximum X resolution", + "name": "maxresolutionx", + "type": "long" + }, + { + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "the VM's primary IP address", + "name": "ipaddress", + "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 name of the affinity group", + "name": "name", + "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 ID of the security group", + "description": "the ID of the affinity group", "name": "id", "type": "string" }, { - "description": "the project name of the group", + "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 project name of the affinity group", "name": "project", "type": "string" }, { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" + "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 domain name of the affinity group", + "name": "domain", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "OS name of the vm", + "name": "osdisplayname", + "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": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", + "type": "string" + }, + { + "description": "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 memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, + { + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "type": "string" + }, + { + "description": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" + }, + { + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "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 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": "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" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "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" } ], "type": "set" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "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", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "CPU arch of the VM", + "name": "arch", + "type": "string" + }, + { + "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 name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" + }, + { + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" + }, + { + "description": "the id of userdata used for the VM", + "name": "userdataid", + "type": "string" + }, + { + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" + }, + { + "description": "the maximum Y resolution", + "name": "maxresolutiony", + "type": "long" + }, + { + "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": "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": "the name of the virtual machine", + "name": "name", + "type": "string" + }, + { + "description": "the password (if exists) of the virtual machine", + "name": "password", + "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": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", + "type": "string" + }, + { + "description": "Instance lease duration in days", + "name": "leaseduration", + "type": "integer" + }, + { + "description": "the user's name who deployed the virtual machine", + "name": "username", + "type": "string" + }, + { + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", + "type": "string" + }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + {}, + { + "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 maximum number of display heads", + "name": "maxheads", + "type": "long" + }, + { + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "the pool type of the virtual machine", + "name": "pooltype", + "type": "string" + }, + { + "description": "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" }, { @@ -61179,24 +61289,119 @@ "name": "ostypeid", "type": "string" }, + { + "description": "the format of the template for the virtual machine", + "name": "templateformat", + "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": "the vGPU type used by the virtual machine", + "name": "vgpu", + "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 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 account associated with the virtual machine", + "name": "account", + "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 write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + { + "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 outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, { "description": "the name of userdata used for the VM", "name": "userdataname", "type": "string" }, { - "description": "the ID of the vgpu profile to which service offering is linked", - "name": "vgpuprofileid", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", + "type": "string" + }, + { + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", + "type": "string" + }, + { + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, + { + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" + }, + { + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", + "type": "string" + }, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" } ] @@ -61216,17 +61421,6 @@ } ], "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", @@ -61237,7 +61431,18 @@ "description": "the UUID of the latest async 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.17.0" }, @@ -61254,45 +61459,45 @@ "type": "boolean" }, { - "description": "Id of the Bgp Peer", - "length": 255, - "name": "id", - "related": "createBgpPeer,listBgpPeers,updateBgpPeer,dedicateBgpPeer,releaseBgpPeer", - "required": true, - "type": "uuid" - }, - { - "description": "The AS number of the Bgp Peer.", + "description": "BGP peer details in key/value pairs.", "length": 255, - "name": "asnumber", + "name": "details", "required": false, - "type": "long" + "type": "map" }, { - "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" }, { - "description": "BGP peer details in key/value pairs.", + "description": "The AS number of the Bgp Peer.", "length": 255, - "name": "details", + "name": "asnumber", "required": false, - "type": "map" + "type": "long" }, { - "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": "Id of the Bgp Peer", "length": 255, - "name": "password", + "name": "id", + "related": "createBgpPeer,listBgpPeers,updateBgpPeer,dedicateBgpPeer,releaseBgpPeer", + "required": true, + "type": "uuid" + }, + { + "description": "The IPv4 address of the Bgp Peer.", + "length": 255, + "name": "ipaddress", "required": false, "type": "string" } @@ -61300,18 +61505,18 @@ "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": "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" }, { @@ -61320,14 +61525,18 @@ "type": "string" }, { - "description": "IPv6 address of bgp peer", - "name": "ip6address", + "description": "IPv4 address of bgp peer", + "name": "ipaddress", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project name of the bgp peer", + "name": "project", + "type": "string" + }, + { + "description": "the account of the bgp peer", + "name": "account", "type": "string" }, { @@ -61336,34 +61545,28 @@ "type": "date" }, { - "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": "IPv4 address of bgp peer", - "name": "ipaddress", - "type": "string" + "description": "AS number of bgp peer", + "name": "asnumber", + "type": "long" }, { - "description": "id of the bgp peer", - "name": "id", + "description": "password of bgp peer", + "name": "password", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, - { - "description": "id of zone to which the bgp peer belongs to.", - "name": "zoneid", + "description": "the project id of the bgp peer", + "name": "projectid", "type": "string" }, { - "description": "name of zone to which the bgp peer belongs to.", - "name": "zonename", + "description": "the domain ID of the bgp peer", + "name": "domainid", "type": "string" }, { @@ -61372,13 +61575,15 @@ "type": "map" }, { - "description": "the project id of the bgp peer", - "name": "projectid", + "description": "IPv6 address of bgp peer", + "name": "ip6address", "type": "string" }, + {}, + {}, { - "description": "the account of the bgp peer", - "name": "account", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ], @@ -61390,136 +61595,136 @@ "name": "updateTungstenFabricLBHealthMonitor", "params": [ { - "description": "the ID of lb rule", + "description": "loadbalancer health monitor timeout", "length": 255, - "name": "lbruleid", - "related": "createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,updateIpv6FirewallRule", + "name": "timeout", "required": true, - "type": "uuid" + "type": "integer" }, { - "description": "loadbalancer health monitor timeout", + "description": "loadbalancer health monitor type", "length": 255, - "name": "timeout", + "name": "type", "required": true, - "type": "integer" + "type": "string" }, { - "description": "loadbalancer health monitor expected code", + "description": "loadbalancer health monitor http method", "length": 255, - "name": "expectedcode", + "name": "httpmethodtype", "required": false, "type": "string" }, { - "description": "loadbalancer health monitor interval", + "description": "loadbalancer health monitor retry", "length": 255, - "name": "interval", + "name": "retry", "required": true, "type": "integer" }, { - "description": "loadbalancer health monitor type", + "description": "loadbalancer health monitor url path", "length": 255, - "name": "type", - "required": true, + "name": "urlpath", + "required": false, "type": "string" }, { - "description": "loadbalancer health monitor retry", + "description": "loadbalancer health monitor interval", "length": 255, - "name": "retry", + "name": "interval", "required": true, "type": "integer" }, { - "description": "loadbalancer health monitor url path", + "description": "loadbalancer health monitor expected code", "length": 255, - "name": "urlpath", + "name": "expectedcode", "required": false, "type": "string" }, { - "description": "loadbalancer health monitor http method", + "description": "the ID of lb rule", "length": 255, - "name": "httpmethodtype", - "required": false, - "type": "string" + "name": "lbruleid", + "related": "createRoutingFirewallRule,listRoutingFirewallRules,updateIpv6FirewallRule,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule", + "required": true, + "type": "uuid" } ], "related": "", "response": [ { - "description": "the health monitor UUID", - "name": "uuid", + "description": "the health monitor url path", + "name": "urlpath", "type": "string" }, + {}, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "the health monitor type", + "name": "type", "type": "string" }, { - "description": "the health monitor type", - "name": "type", + "description": "the health monitor UUID", + "name": "uuid", "type": "string" }, { - "description": "the LB rule ID", - "name": "lbruleid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the health monitor expected code", - "name": "expectedcode", + "description": "the health monitor http method", + "name": "httpmethod", "type": "string" }, + {}, { "description": "the health monitor timeout", "name": "timeout", "type": "int" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" }, { "description": "the health monitor interval", "name": "interval", "type": "int" }, - {}, - { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" - }, { "description": "the health monitor retry", "name": "retry", "type": "int" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, { - "description": "the health monitor url path", - "name": "urlpath", - "type": "string" + "description": "the health monitor ID", + "name": "id", + "type": "long" }, { - "description": "the health monitor http method", - "name": "httpmethod", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the health monitor expected code", + "name": "expectedcode", "type": "string" }, { - "description": "the health monitor ID", - "name": "id", - "type": "long" + "description": "the LB rule ID", + "name": "lbruleid", + "type": "string" } ] }, @@ -61532,18 +61737,13 @@ "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": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, {}, { "description": "the current status of the latest async job acting on this object", @@ -61551,14 +61751,19 @@ "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" } ] }, @@ -61568,11 +61773,11 @@ "name": "updateProjectInvitation", "params": [ { - "description": "User UUID, required for adding account from external provisioning system", + "description": "id of the project to join", "length": 255, - "name": "userid", - "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser", - "required": false, + "name": "projectid", + "related": "activateProject,createProject,suspendProject", + "required": true, "type": "uuid" }, { @@ -61582,6 +61787,14 @@ "required": false, "type": "boolean" }, + { + "description": "User UUID, required for adding account from external provisioning system", + "length": 255, + "name": "userid", + "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser", + "required": false, + "type": "uuid" + }, { "description": "list invitations for specified account; this parameter has to be specified with domainId", "length": 255, @@ -61595,28 +61808,14 @@ "name": "account", "required": false, "type": "string" - }, - { - "description": "id of the project to join", - "length": 255, - "name": "projectid", - "related": "activateProject,createProject,suspendProject", - "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", @@ -61627,7 +61826,13 @@ "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - } + }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {} ], "since": "3.0.0" }, @@ -61648,117 +61853,25 @@ "related": "createSnapshotFromVMSnapshot,copySnapshot,archiveSnapshot,listSnapshots,listSnapshots", "response": [ { - "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 project name of the snapshot", - "name": "project", - "type": "string" - }, - { - "description": "type of the datastore for the snapshot entry", - "name": "datastoretype", - "type": "string" - }, - { - "description": "the domain ID of the snapshot's account", - "name": "domainid", - "type": "string" - }, - { - "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 status of the template", - "name": "status", - "type": "string" - }, - { - "description": "path of the Domain the snapshot's account belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the account associated with the snapshot", - "name": "account", - "type": "string" - }, - { - "description": "id of the os on volume", - "name": "ostypeid", + "description": "name of the datastore for the snapshot entry", + "name": "datastorename", "type": "string" }, { - "description": "indicates whether the underlying storage supports reverting the volume to this snapshot", - "name": "revertable", - "type": "boolean" - }, - { - "description": "ID of the snapshot", - "name": "id", - "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 disk volume", - "name": "volumename", - "type": "string" + "description": " the date the snapshot was created", + "name": "created", + "type": "date" }, { "description": "the state of the snapshot. BackedUp means that snapshot is ready to be used; Creating - the snapshot is being allocated on the primary storage; BackingUp - the snapshot is being backed up on secondary storage", "name": "state", "type": "state" }, - { - "description": "the type of the snapshot", - "name": "snapshottype", - "type": "string" - }, - { - "description": "name of the datastore for the snapshot entry", - "name": "datastorename", - "type": "string" - }, - { - "description": "name of the snapshot", - "name": "name", - "type": "string" - }, - { - "description": "ID of the datastore for the snapshot entry", - "name": "datastoreid", - "type": "string" - }, - { - "description": "the project id of the snapshot", - "name": "projectid", - "type": "string" - }, - { - "description": "ID of the disk volume", - "name": "volumeid", - "type": "string" - }, - { - "description": "state of the disk volume", - "name": "volumestate", - "type": "string" - }, { "description": "the list of resource tags associated", "name": "tags", @@ -61769,8 +61882,8 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -61779,57 +61892,103 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the 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": "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": "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": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" } ], "type": "set" }, + { + "description": "valid types are hourly, daily, weekly, monthy, template, and none.", + "name": "intervaltype", + "type": "string" + }, + { + "description": "physical size of backedup snapshot on image store", + "name": "physicalsize", + "type": "long" + }, + { + "description": "type of the datastore for the snapshot entry", + "name": "datastoretype", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the type of the snapshot", + "name": "snapshottype", + "type": "string" + }, + { + "description": "path of the Domain the snapshot's 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 date the snapshot was created", - "name": "created", - "type": "date" + "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": "ID of the disk volume", + "name": "volumeid", + "type": "string" + }, + { + "description": "state of the disk volume", + "name": "volumestate", + "type": "string" }, { "description": "download progress of a snapshot", @@ -61837,23 +61996,23 @@ "type": "map" }, { - "description": "display name of the os on volume", - "name": "osdisplayname", + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "display name of the os on volume", + "name": "osdisplayname", + "type": "string" }, { - "description": "chain size of snapshot including all parent snapshots. Shown only for incremental snapshots if snapshot.show.chain.size setting is set to true", - "name": "chainsize", - "type": "long" + "description": "the project name of the snapshot", + "name": "project", + "type": "string" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "name of the disk volume", + "name": "volumename", "type": "string" }, { @@ -61862,24 +62021,70 @@ "type": "string" }, { - "description": "virtual size of backedup snapshot on image store", - "name": "virtualsize", - "type": "long" + "description": "id of the os on volume", + "name": "ostypeid", + "type": "string" + }, + { + "description": "id of the availability zone", + "name": "zoneid", + "type": "string" + }, + { + "description": "ID of the datastore for the snapshot entry", + "name": "datastoreid", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, { - "description": "the domain name of the snapshot's account", - "name": "domain", + "description": "the project id of the snapshot", + "name": "projectid", "type": "string" }, { - "description": "id of the availability zone", - "name": "zoneid", + "description": "name of the snapshot", + "name": "name", + "type": "string" + }, + { + "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": "type of the disk volume", + "name": "volumetype", + "type": "string" + }, + { + "description": "the status of the template", + "name": "status", + "type": "string" + }, + { + "description": "ID of the snapshot", + "name": "id", "type": "string" + }, + { + "description": "the account associated with the snapshot", + "name": "account", + "type": "string" + }, + { + "description": "virtual size of backedup snapshot on image store", + "name": "virtualsize", + "type": "long" } ] }, @@ -61895,13 +62100,6 @@ "required": true, "type": "long" }, - { - "description": "Relational Operator to be used with threshold. Valid values are EQ, GT, LT, GE, LE.", - "length": 255, - "name": "relationaloperator", - "required": true, - "type": "string" - }, { "description": "the ID of the condition.", "length": 255, @@ -61909,30 +62107,37 @@ "related": "listConditions", "required": true, "type": "uuid" + }, + { + "description": "Relational Operator to be used with threshold. Valid values are EQ, GT, LT, GE, LE.", + "length": 255, + "name": "relationaloperator", + "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 UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, {}, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, {} ], "since": "4.18.0" @@ -61943,79 +62148,79 @@ "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": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "List Region by region name.", + "description": "", "length": 255, - "name": "name", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "", + "description": "List Region by region ID.", "length": 255, - "name": "pagesize", + "name": "id", "required": false, "type": "integer" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" } ], "related": "addRegion,updateRegion", "response": [ + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the ID of the region", + "name": "id", "type": "integer" }, { - "description": "the end point of the region", - "name": "endpoint", + "description": "the name of the region", + "name": "name", "type": "string" }, - {}, { - "description": "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 name of the region", - "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 region", - "name": "id", - "type": "integer" + "description": "true if security groups support is enabled, false otherwise", + "name": "portableipserviceenabled", + "type": "boolean" }, - {}, { "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 UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ] }, @@ -62025,156 +62230,154 @@ "name": "migrateSystemVm", "params": [ { - "description": "Destination storage pool ID to migrate VM volumes to. Required for migrating the root disk volume", + "description": "the ID of the virtual machine", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", - "required": false, - "since": "4.16.0", + "name": "virtualmachineid", + "related": "migrateSystemVm,startSystemVm,changeServiceForSystemVm", + "required": true, "type": "uuid" }, { - "description": "destination Host ID to migrate VM to", + "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": "hostid", - "related": "cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost,addBaremetalHost", + "name": "autoselect", "required": false, - "type": "uuid" + "since": "4.16.0", + "type": "boolean" }, { - "description": "Automatically select a destination host which do not require storage migration, if hostId and storageId are not specified. false by default", + "description": "Destination storage pool ID to migrate VM volumes to. Required for migrating the root disk volume", "length": 255, - "name": "autoselect", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", "required": false, "since": "4.16.0", - "type": "boolean" + "type": "uuid" }, { - "description": "the ID of the virtual machine", + "description": "destination Host ID to migrate VM to", "length": 255, - "name": "virtualmachineid", - "related": "migrateSystemVm,startSystemVm,changeServiceForSystemVm", - "required": true, + "name": "hostid", + "related": "addBaremetalHost,cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost", + "required": false, "type": "uuid" } ], "related": "startSystemVm,changeServiceForSystemVm", "response": [ { - "description": "the Pod name for the system VM", - "name": "podname", + "description": "the agent state of the system VM", + "name": "agentstate", "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 host ID for the system VM", - "name": "hostid", + "description": "the private MAC address for the system VM", + "name": "privatemacaddress", "type": "string" }, { - "description": "the second DNS for the system VM", - "name": "dns2", + "description": "the private IP address for the system VM", + "name": "privateip", "type": "string" }, { - "description": "the Zone name for the system VM", - "name": "zonename", + "description": "the ID of the service offering of the system virtual machine.", + "name": "serviceofferingid", "type": "string" }, { - "description": "the Pod ID for the system VM", - "name": "podid", + "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 template name for the system VM", + "name": "templatename", "type": "string" }, { - "description": "the number of active console sessions for the console proxy system vm", - "name": "activeviewersessions", - "type": "integer" + "description": "the link local netmask for the system vm", + "name": "linklocalnetmask", + "type": "string" }, { - "description": "the ID of the system VM", - "name": "id", + "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 Pod ID for the system VM", + "name": "podid", "type": "string" }, - {}, { - "description": "the private MAC address for the system VM", - "name": "privatemacaddress", + "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 gateway for the system VM", + "name": "gateway", + "type": "string" }, { - "description": "public vlan range", - "name": "publicvlan", - "type": "list" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the ID of the service offering of the system virtual machine.", - "name": "serviceofferingid", + "description": "the link local MAC address for the system vm", + "name": "linklocalmacaddress", "type": "string" }, { - "description": "the link local IP address for the system vm", - "name": "linklocalip", + "description": "the public MAC address for the system VM", + "name": "publicmacaddress", "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 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", + "description": "the control state of the host for the system VM", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the private IP address for the system VM", - "name": "privateip", + "description": "the name of the service offering of the system virtual machine.", + "name": "serviceofferingname", "type": "string" }, { - "description": "the template name for the system VM", - "name": "templatename", + "description": "the Zone name for the system VM", + "name": "zonename", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "public vlan range", + "name": "publicvlan", + "type": "list" }, { - "description": "the first DNS for the system VM", - "name": "dns1", + "description": "the system VM type", + "name": "systemvmtype", "type": "string" }, { - "description": "the control state of the host for the system VM", - "name": "hostcontrolstate", + "description": "the private netmask for the system VM", + "name": "privatenetmask", "type": "string" }, { @@ -62183,43 +62386,40 @@ "type": "string" }, { - "description": "the public IP address for the system VM", - "name": "publicip", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "guest vlan range", - "name": "guestvlan", + "description": "the ID of the system VM", + "name": "id", "type": "string" }, { - "description": "CPU arch of the system VM", - "name": "arch", + "description": "the first DNS for the system VM", + "name": "dns1", "type": "string" }, + {}, { - "description": "the state of the system VM", - "name": "state", + "description": "CPU arch of the system VM", + "name": "arch", "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": "the host ID for the system VM", + "name": "hostid", + "type": "string" }, { - "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 Pod name for the system VM", + "name": "podname", "type": "string" }, { @@ -62228,9 +62428,9 @@ "type": "date" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "guest vlan range", + "name": "guestvlan", + "type": "string" }, { "description": "the hostname for the system VM", @@ -62238,13 +62438,13 @@ "type": "string" }, { - "description": "the private netmask for the system VM", - "name": "privatenetmask", - "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 MAC address for the system VM", - "name": "publicmacaddress", + "description": "the public IP address for the system VM", + "name": "publicip", "type": "string" }, { @@ -62253,18 +62453,23 @@ "type": "string" }, { - "description": "the Zone ID for the system VM", - "name": "zoneid", + "description": "the state of the system VM", + "name": "state", "type": "string" }, { - "description": "the name of the system VM", - "name": "name", - "type": "string" + "description": "the number of active console sessions for the console proxy system vm", + "name": "activeviewersessions", + "type": "integer" }, { - "description": "the link local MAC address for the system vm", - "name": "linklocalmacaddress", + "description": "the last disconnected date of host", + "name": "disconnected", + "type": "date" + }, + { + "description": "the network domain for the system VM", + "name": "networkdomain", "type": "string" } ] @@ -62274,6 +62479,14 @@ "isasync": false, "name": "listCounters", "params": [ + { + "description": "ID of the Counter.", + "length": 255, + "name": "id", + "related": "createCounter,listCounters", + "required": false, + "type": "uuid" + }, { "description": "Network provider of the counter.", "length": 255, @@ -62283,11 +62496,11 @@ "type": "string" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { "description": "", @@ -62297,26 +62510,18 @@ "type": "integer" }, { - "description": "ID of the Counter.", - "length": 255, - "name": "id", - "related": "createCounter,listCounters", - "required": false, - "type": "uuid" - }, - { - "description": "List by keyword", + "description": "Name of the counter.", "length": 255, - "name": "keyword", + "name": "name", "required": false, "type": "string" }, { - "description": "Name of the counter.", + "description": "", "length": 255, - "name": "name", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { "description": "Source of the counter.", @@ -62328,6 +62533,11 @@ ], "related": "createCounter", "response": [ + { + "description": "zone id of counter", + "name": "zoneid", + "type": "string" + }, { "description": "Provider of the counter.", "name": "provider", @@ -62338,38 +62548,33 @@ "name": "id", "type": "string" }, - { - "description": "Name of the counter.", - "name": "name", - "type": "string" - }, { "description": "Value in case of snmp or other specific counters.", "name": "value", "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": "Source of the counter.", - "name": "source", + "description": "Name of the counter.", + "name": "name", "type": "string" }, { - "description": "zone id of counter", - "name": "zoneid", + "description": "Source of the counter.", + "name": "source", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } + {} ] }, { @@ -62378,50 +62583,50 @@ "name": "configureInternalLoadBalancerElement", "params": [ { - "description": "the ID of the internal lb provider", + "description": "Enables/Disables the Internal Load Balancer element", "length": 255, - "name": "id", - "related": "configureInternalLoadBalancerElement,listInternalLoadBalancerElements", + "name": "enabled", "required": true, - "type": "uuid" + "type": "boolean" }, { - "description": "Enables/Disables the Internal Load Balancer element", + "description": "the ID of the internal lb provider", "length": 255, - "name": "enabled", + "name": "id", + "related": "configureInternalLoadBalancerElement,listInternalLoadBalancerElements", "required": true, - "type": "boolean" + "type": "uuid" } ], "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", "type": "integer" }, + {}, + { + "description": "Enabled/Disabled the element", + "name": "enabled", + "type": "boolean" + }, + {}, { "description": "the physical network service provider id of the element", "name": "nspid", "type": "string" }, { - "description": "Enabled/Disabled the element", - "name": "enabled", - "type": "boolean" + "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" + } ], "since": "4.2.0" }, @@ -62431,11 +62636,11 @@ "name": "removeTungstenFabricTag", "params": [ { - "description": "the uuid of nics", + "description": "the uuid of Tungsten-Fabric tag", "length": 255, - "name": "nicuuid", - "required": false, - "type": "list" + "name": "taguuid", + "required": true, + "type": "string" }, { "description": "the uuid of Tungsten-Fabric policy", @@ -62445,30 +62650,30 @@ "type": "string" }, { - "description": "the uuid of Tungsten-Fabric tag", + "description": "the uuid of Tungsten-Fabric application policy set", "length": 255, - "name": "taguuid", - "required": true, + "name": "applicationpolicysetuuid", + "required": false, "type": "string" }, { - "description": "the uuid of networks", + "description": "the uuid of vms", "length": 255, - "name": "networkuuid", + "name": "vmuuid", "required": false, "type": "list" }, { - "description": "the uuid of Tungsten-Fabric application policy set", + "description": "the uuid of nics", "length": 255, - "name": "applicationpolicysetuuid", + "name": "nicuuid", "required": false, - "type": "string" + "type": "list" }, { - "description": "the uuid of vms", + "description": "the uuid of networks", "length": 255, - "name": "vmuuid", + "name": "networkuuid", "required": false, "type": "list" }, @@ -62483,19 +62688,16 @@ ], "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 network", + "name": "network", "type": "list" }, { @@ -62504,11 +62706,15 @@ "type": "long" }, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "list Tungsten-Fabric vm", + "name": "vm", + "type": "list" + }, + { + "description": "Tungsten-Fabric tag type uuid", + "name": "uuid", "type": "string" }, - {}, { "description": "Tungsten-Fabric tag name", "name": "name", @@ -62519,20 +62725,19 @@ "name": "jobstatus", "type": "integer" }, - { - "description": "list Tungsten-Fabric vm", - "name": "vm", - "type": "list" - }, - {}, { "description": "list Tungsten-Fabric nic", "name": "nic", "type": "list" }, { - "description": "list Tungsten-Fabric network", - "name": "network", + "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" } ] @@ -62550,34 +62755,34 @@ "type": "integer" }, { - "description": "list virtual router elements by id", + "description": "list network offerings by enabled state", "length": 255, - "name": "id", - "related": "configureVirtualRouterElement,listVirtualRouterElements", + "name": "enabled", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "list network offerings by enabled state", + "description": "", "length": 255, - "name": "enabled", + "name": "pagesize", "required": false, - "type": "boolean" + "type": "integer" }, { - "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": "", + "description": "list virtual router elements by network service provider id", "length": 255, - "name": "pagesize", + "name": "nspid", + "related": "addNetworkServiceProvider,listNetworkServiceProviders", "required": false, - "type": "integer" + "type": "uuid" }, { "description": "List by keyword", @@ -62595,14 +62800,19 @@ "type": "string" }, { - "description": "the account associated with the provider", - "name": "account", + "description": "path of the domain to which the provider belongs", + "name": "domainpath", "type": "string" }, { - "description": "Enabled/Disabled the service provider", - "name": "enabled", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the project name of the address", + "name": "project", + "type": "string" }, { "description": "the domain associated with the provider", @@ -62610,20 +62820,20 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the physical network service provider id of the provider", + "name": "nspid", + "type": "string" }, - {}, { "description": "the domain ID associated with the provider", "name": "domainid", "type": "string" }, + {}, { - "description": "the physical network service provider id of the provider", - "name": "nspid", - "type": "string" + "description": "Enabled/Disabled the service provider", + "name": "enabled", + "type": "boolean" }, { "description": "the UUID of the latest async job acting on this object", @@ -62631,21 +62841,16 @@ "type": "string" }, { - "description": "path of the domain to which the provider belongs", - "name": "domainpath", + "description": "the account associated with the provider", + "name": "account", "type": "string" }, + {}, { "description": "the project id of the ipaddress", "name": "projectid", "type": "string" - }, - { - "description": "the project name of the address", - "name": "project", - "type": "string" - }, - {} + } ] }, { @@ -62663,27 +62868,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": "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.20.0" @@ -62703,28 +62908,28 @@ } ], "response": [ - {}, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - {} + {}, + { + "description": "the 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" }, @@ -62734,11 +62939,11 @@ "name": "createRoutingFirewallRule", "params": [ { - "description": "the protocol for the firewall rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number", + "description": "an optional field, whether to the display the rule to the end user or not", "length": 255, - "name": "protocol", - "required": true, - "type": "string" + "name": "fordisplay", + "required": false, + "type": "boolean" }, { "description": "error code for this ICMP message", @@ -62748,54 +62953,54 @@ "type": "integer" }, { - "description": "the ending port of firewall rule", + "description": "The network of the VM the firewall rule will be created for", "length": 255, - "name": "endport", - "required": false, - "type": "integer" + "name": "networkid", + "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "required": true, + "type": "uuid" }, { - "description": "type of the ICMP message being sent", + "description": "the source CIDR list to allow 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 starting port of firewall rule", + "description": "type of the ICMP message being sent", "length": 255, - "name": "startport", + "name": "icmptype", "required": false, "type": "integer" }, { - "description": "an optional field, whether to the display the rule to the end user or not", + "description": "the destination CIDR list to allow traffic to. Multiple entries must be separated by a single comma character (,).", "length": 255, - "name": "fordisplay", + "name": "destcidrlist", "required": false, - "type": "boolean" + "type": "list" }, { - "description": "The network of the VM the firewall rule will be created for", + "description": "the protocol for the firewall rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number", "length": 255, - "name": "networkid", - "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "protocol", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "the source CIDR list to allow traffic from. Multiple entries must be separated by a single comma character (,).", + "description": "the starting port of firewall rule", "length": 255, - "name": "cidrlist", + "name": "startport", "required": false, - "type": "list" + "type": "integer" }, { - "description": "the destination CIDR list to allow traffic to. Multiple entries must be separated by a single comma character (,).", + "description": "the ending port of firewall rule", "length": 255, - "name": "destcidrlist", + "name": "endport", "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", @@ -62805,20 +63010,36 @@ "type": "string" } ], - "related": "listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,updateIpv6FirewallRule", + "related": "listRoutingFirewallRules,updateIpv6FirewallRule,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule", "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", + "type": "string" + }, + { + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", + "type": "string" + }, + { + "description": "the VM name for the port forwarding rule", + "name": "virtualmachinename", + "type": "string" + }, + {}, { "description": "the 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", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -62832,23 +63053,23 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "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" }, { @@ -62857,47 +63078,46 @@ "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 project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", "type": "string" } ], "type": "list" }, { - "description": "the VM display name for the port forwarding rule", - "name": "virtualmachinedisplayname", + "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", + "description": "the starting port of port forwarding rule's private port range", + "name": "privateport", "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", + "description": "the protocol of the port forwarding rule", + "name": "protocol", "type": "string" }, { - "description": "the VM name for the port forwarding rule", - "name": "virtualmachinename", + "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 public port range", - "name": "publicport", + "description": "the id of the guest network the port forwarding rule belongs to", + "name": "networkid", "type": "string" }, { @@ -62906,23 +63126,18 @@ "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 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 state of the rule", + "name": "state", "type": "string" }, { - "description": "the state of the rule", - "name": "state", + "description": "the VM display name for the port forwarding rule", + "name": "virtualmachinedisplayname", "type": "string" }, { @@ -62930,37 +63145,27 @@ "name": "fordisplay", "type": "boolean" }, - { - "description": "the public ip address id for the port forwarding rule", - "name": "ipaddressid", - "type": "string" - }, - { - "description": "the starting port of port forwarding rule's private port range", - "name": "privateport", - "type": "string" - }, - { - "description": "the protocol of the port forwarding rule", - "name": "protocol", - "type": "string" - }, { "description": "the public ip address for the port forwarding rule", "name": "ipaddress", "type": "string" }, { - "description": "the ID of the port forwarding rule", - "name": "id", + "description": "the vm ip address for the port forwarding rule", + "name": "vmguestip", "type": "string" }, { - "description": "the id of the guest network the port forwarding rule belongs to", - "name": "networkid", + "description": "the starting port of port forwarding rule's public port range", + "name": "publicport", "type": "string" }, - {} + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } ], "since": "4.20.0" }, @@ -62970,9 +63175,17 @@ "name": "linkAccountToLdap", "params": [ { - "description": "name of the group or OU in LDAP", + "description": "The id of the domain that is to contain the linked account.", "length": 255, - "name": "ldapdomain", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "required": true, + "type": "uuid" + }, + { + "description": "name of the account, it will be created if it does not exist", + "length": 255, + "name": "account", "required": true, "type": "string" }, @@ -62984,25 +63197,24 @@ "type": "integer" }, { - "description": "type of the ldap name. GROUP or OU, defaults to GROUP", + "description": "domain admin username in LDAP ", "length": 255, - "name": "type", + "name": "admin", "required": false, "type": "string" }, { - "description": "The id of the domain that is to contain the linked account.", + "description": "type of the ldap name. GROUP or OU, defaults to GROUP", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", - "required": true, - "type": "uuid" + "name": "type", + "required": false, + "type": "string" }, { - "description": "domain admin username in LDAP ", + "description": "name of the group or OU in LDAP", "length": 255, - "name": "admin", - "required": false, + "name": "ldapdomain", + "required": true, "type": "string" }, { @@ -63013,21 +63225,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": "name of the group or OU in LDAP which is linked to the domain", + "name": "name", "type": "string" }, { @@ -63035,35 +63239,36 @@ "name": "ldapdomain", "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": "Type of the account to auto import", + "name": "accounttype", + "type": "int" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, { - "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": "Type of the account to auto import", - "name": "accounttype", - "type": "int" - }, - { - "description": "id of the Domain which is linked to LDAP", - "name": "domainid", + "description": "type of the name in LDAP which is linked to the domain", + "name": "type", "type": "string" } ], @@ -63078,7 +63283,7 @@ "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" } @@ -63086,71 +63291,71 @@ "related": "enableOutOfBandManagementForHost,disableOutOfBandManagementForCluster,configureOutOfBandManagement,changeOutOfBandManagementPassword", "response": [ { - "description": "the out-of-band management interface address", - "name": "address", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "true if out-of-band management is enabled for the host", - "name": "enabled", - "type": "boolean" + "description": "the out-of-band management interface powerState of the host", + "name": "powerstate", + "type": "powerstate" }, { - "description": "the out-of-band management action (if issued)", - "name": "action", + "description": "the operation result description", + "name": "description", "type": "string" }, - {}, { - "description": "the out-of-band management interface powerState of the host", - "name": "powerstate", - "type": "powerstate" + "description": "the out-of-band management interface password", + "name": "password", + "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the operation result", + "name": "status", + "type": "boolean" }, { - "description": "the ID of the host", - "name": "hostid", + "description": "the out-of-band management driver for the host", + "name": "driver", "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", + "description": "the out-of-band management interface username", + "name": "username", "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 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 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 ID of the host", + "name": "hostid", "type": "string" }, { - "description": "the operation result", - "name": "status", - "type": "boolean" + "description": "the out-of-band management interface port", + "name": "port", + "type": "string" } ], "since": "4.9.0" @@ -63164,66 +63369,56 @@ "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", - "type": "string" + "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", + "name": "suitableformigration", + "type": "boolean" }, { - "description": "the amount of the host's CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", + "description": "the admin that annotated this host", + "name": "username", "type": "string" }, { - "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 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 CPU number of the host", - "name": "cpunumber", - "type": "integer" + "description": "true if the host is disconnected. False otherwise.", + "name": "disconnected", + "type": "date" }, { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", + "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": "the amount of the host's CPU currently allocated in MHz", - "name": "cpuallocatedvalue", - "type": "long" + "description": "the number of CPU sockets on the host", + "name": "cpusockets", + "type": "integer" }, { - "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", + "description": "the IP address of the host", + "name": "ipaddress", "type": "string" }, { - "description": "Total GPUs on the Host", - "name": "gputotal", - "type": "long" - }, - { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", + "description": "the amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", "type": "long" }, { @@ -63232,19 +63427,14 @@ "type": "string" }, { - "description": "events available for the host", - "name": "events", - "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 cluster type of the cluster that host belongs to", - "name": "clustertype", - "type": "string" + "description": "Used GPUs on the Host", + "name": "gpuused", + "type": "long" }, { "description": "comma-separated list of implicit host tags for the host", @@ -63252,68 +63442,9 @@ "type": "string" }, { - "description": "GPU cards present in the host", - "name": "gpugroup", - "response": [ - { - "description": "the list of enabled vGPUs", - "name": "vgpu", - "response": [ - { - "description": "Maximum X resolution per display", - "name": "maxresolutionx", - "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": "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": "Maximum Y resolution per display", - "name": "maxresolutiony", - "type": "long" - }, - { - "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", - "name": "remainingcapacity", - "type": "long" - } - ], - "type": "list" - }, - { - "description": "GPU cards present in the host", - "name": "gpugroupname", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "the cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" + "description": "The ID of extension for this cluster", + "name": "extensionid", + "type": "string" }, { "description": "true if local storage is active, false otherwise", @@ -63321,155 +63452,199 @@ "type": "boolean" }, { - "description": "true if the host is disconnected. False otherwise.", - "name": "disconnected", + "description": "the last time this host was annotated", + "name": "lastannotated", "type": "date" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "comma-separated list of storage access groups on the zone", - "name": "zonestorageaccessgroups", + "description": "the Pod ID of the host", + "name": "podid", "type": "string" }, { - "description": "The ID of extension for this cluster", - "name": "extensionid", - "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", + "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 OS category name of the host", - "name": "oscategoryname", + "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "name": "memorytotal", + "type": "long" + }, + { + "description": "comma-separated list of storage access groups on the cluster", + "name": "clusterstorageaccessgroups", "type": "string" }, { - "description": "the cluster ID of the host", - "name": "clusterid", + "description": "the management server name of the host", + "name": "managementservername", "type": "string" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" + "description": "the name of the host", + "name": "name", + "type": "string" }, - {}, { - "description": "comma-separated list of explicit host tags for the host", - "name": "explicithosttags", + "description": "the host hypervisor", + "name": "hypervisor", "type": "string" }, { - "description": "the host type", - "name": "type", - "type": "type" + "description": "Host details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the Zone name of the host", - "name": "zonename", + "description": "capabilities of the host", + "name": "capabilities", "type": "string" }, + {}, { - "description": "the cluster name of the host", - "name": "clustername", + "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 cluster ID of the host", + "name": "clusterid", "type": "string" }, + {}, { - "description": "the date and time the host was created", - "name": "created", - "type": "date" + "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 host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" }, { - "description": "true if the host supports encryption", - "name": "encryptionsupported", - "type": "boolean" + "description": "the management server ID of the host", + "name": "managementserverid", + "type": "string" }, { - "description": "Host details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the OS category name of the host", + "name": "oscategoryname", + "type": "string" }, - {}, { - "description": "the state of the host", - "name": "state", - "type": "status" + "description": "the host version", + "name": "version", + "type": "string" }, { - "description": "the last time this host was annotated", - "name": "lastannotated", - "type": "date" + "description": "the Zone ID of the host", + "name": "zoneid", + "type": "string" }, { - "description": "the amount of the host's memory currently used", - "name": "memoryused", - "type": "long" + "description": "the cpu average load on the host", + "name": "cpuloadaverage", + "type": "double" + }, + { + "description": "GPU cards present in the host", + "name": "gpugroup", + "response": [ + { + "description": "GPU cards present in the host", + "name": "gpugroupname", + "type": "string" + }, + { + "description": "the list of enabled vGPUs", + "name": "vgpu", + "response": [ + { + "description": "Video RAM for this vGPU type", + "name": "videoram", + "type": "long" + }, + { + "description": "Maximum X resolution per display", + "name": "maxresolutionx", + "type": "long" + }, + { + "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", + "name": "remainingcapacity", + "type": "long" + }, + { + "description": "Maximum displays per user", + "name": "maxheads", + "type": "long" + }, + { + "description": "Maximum Y resolution per display", + "name": "maxresolutiony", + "type": "long" + }, + { + "description": "Maximum no. of vgpu per gpu card (pgpu)", + "name": "maxvgpuperpgpu", + "type": "long" + }, + { + "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", + "name": "maxcapacity", + "type": "long" + }, + { + "description": "Model Name of vGPU", + "name": "vgputype", + "type": "string" + } + ], + "type": "list" + } + ], + "type": "list" }, { - "description": "the host hypervisor", - "name": "hypervisor", + "description": "the hypervisor version", + "name": "hypervisorversion", "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", + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", "type": "string" }, { - "description": "the CPU speed of the host", - "name": "cpuspeed", + "description": "the incoming network traffic on the host", + "name": "networkkbsread", "type": "long" }, { - "description": "capabilities of the host", - "name": "capabilities", - "type": "string" - }, - { - "description": "the hypervisor version", - "name": "hypervisorversion", - "type": "string" + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" }, { - "description": "the IP address of the host", - "name": "ipaddress", - "type": "string" + "description": "the host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" }, { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", + "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": "Total GPUs on the Host", + "name": "gputotal", "type": "long" }, { @@ -63478,44 +63653,39 @@ "type": "string" }, { - "description": "the resource state of the host", - "name": "resourcestate", - "type": "string" - }, - { - "description": "the admin that annotated this host", - "name": "username", + "description": "the amount of the host's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "comma-separated list of storage access groups for the host", - "name": "storageaccessgroups", - "type": "string" + "description": "true if the host supports encryption", + "name": "encryptionsupported", + "type": "boolean" }, { - "description": "the OS category ID of the host", - "name": "oscategoryid", - "type": "string" + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" }, { - "description": "the virtual machine id for host type ConsoleProxy and SecondaryStorageVM", - "name": "virtualmachineid", + "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 date and time the host was last pinged", + "name": "lastpinged", + "type": "date" }, { - "description": "the Pod name of the host", - "name": "podname", + "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 amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", + "type": "string" }, { "description": "CPU Arch of the host", @@ -63523,38 +63693,33 @@ "type": "string" }, { - "description": "the Pod ID of the host", - "name": "podid", + "description": "the cluster name of the host", + "name": "clustername", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", + "description": "the cluster type of the cluster that host belongs to", + "name": "clustertype", "type": "string" }, { - "description": "the number of CPU sockets on the host", - "name": "cpusockets", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", + "description": "the amount of the host's memory currently used", + "name": "memoryused", "type": "long" }, { - "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", - "type": "long" + "description": "the state of the host", + "name": "state", + "type": "status" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the host", + "name": "id", "type": "string" }, { @@ -63563,55 +63728,95 @@ "type": "string" }, { - "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", - "name": "hasenoughcapacity", + "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 amount of the host's CPU currently allocated", + "name": "cpuallocated", + "type": "string" }, { "description": "true if the host supports instance conversion (using virt-v2v)", "name": "instanceconversionsupported", "type": "boolean" }, - {}, { - "description": "the ID of the host", - "name": "id", + "description": "the date and time the host was created", + "name": "created", + "type": "date" + }, + { + "description": "The name of extension for this cluster", + "name": "extensionname", "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 after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", "type": "string" }, { - "description": "the management server name of the host", - "name": "managementservername", + "description": "the host HA information information", + "name": "hostha", + "type": "hostharesponse" + }, + { + "description": "true if the host has capability to support UEFI boot", + "name": "ueficapability", + "type": "boolean" + }, + { + "description": "the Zone name of the host", + "name": "zonename", "type": "string" }, { - "description": "The name of extension for this cluster", - "name": "extensionname", + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "the host type", + "name": "type", + "type": "type" + }, + { + "description": "the amount of the host's memory currently allocated in bytes", + "name": "memoryallocatedbytes", + "type": "long" + }, + { + "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", + "description": "comma-separated list of storage access groups on the pod", + "name": "podstorageaccessgroups", + "type": "string" + }, + { + "description": "the CPU number of the host", + "name": "cpunumber", "type": "integer" }, { - "description": "comma-separated list of storage access groups on the cluster", - "name": "clusterstorageaccessgroups", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the virtual machine id for host type ConsoleProxy and SecondaryStorageVM", + "name": "virtualmachineid", "type": "string" }, { - "description": "the host HA information information", - "name": "hostha", - "type": "hostharesponse" + "description": "the Pod name of the host", + "name": "podname", + "type": "string" } ], "since": "4.16.0.0" @@ -63621,13 +63826,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 +63833,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": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, - {} + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + } ], "since": "4.20.0" }, @@ -63676,16 +63881,17 @@ "type": "string" }, { - "description": "the description of the security group", + "description": "Create security group for project", "length": 255, - "name": "description", + "name": "projectid", + "related": "activateProject,createProject,suspendProject", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "an optional account for the security group. Must be used with domainId.", + "description": "the description of the security group", "length": 255, - "name": "account", + "name": "description", "required": false, "type": "string" }, @@ -63698,29 +63904,34 @@ "type": "uuid" }, { - "description": "Create security group for project", + "description": "an optional account for the security group. Must be used with domainId.", "length": 255, - "name": "projectid", - "related": "activateProject,createProject,suspendProject", + "name": "account", "required": false, - "type": "uuid" + "type": "string" } ], "related": "updateSecurityGroup", "response": [ { - "description": "the project id of the group", - "name": "projectid", + "description": "the description of the security group", + "name": "description", "type": "string" }, + {}, { - "description": "the name of the security group", - "name": "name", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the ID of the security group", + "name": "id", "type": "string" }, { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", + "description": "the account owning the security group", + "name": "account", "type": "string" }, { @@ -63729,18 +63940,28 @@ "type": "integer" }, { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", + "description": "the project name of the group", + "name": "project", + "type": "string" + }, + { + "description": "the 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 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", @@ -63752,28 +63973,28 @@ "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "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": "resource type", - "name": "resourcetype", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -63782,8 +64003,8 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -63792,36 +64013,36 @@ "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": "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 ending IP of the security group rule ", + "name": "endport", "type": "integer" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "account owning the security group rule", + "name": "account", "type": "string" }, { @@ -63830,153 +64051,69 @@ "type": "integer" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, { - "description": "the 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", + "description": "the protocol of the security group rule", + "name": "protocol", "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 account owning the security group", - "name": "account", - "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": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag value", - "name": "value", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", - "type": "string" + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" }, { - "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" - } - ], - "type": "set" - }, - {}, - { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the project name of the group", - "name": "project", - "type": "string" - }, - { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", - "response": [ - { - "description": "the code for the ICMP message response", - "name": "icmpcode", + "description": "the ending IP of the security group rule ", + "name": "endport", "type": "integer" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag value", + "name": "value", "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" }, { @@ -63985,8 +64122,8 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -63995,13 +64132,13 @@ "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 ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -64010,128 +64147,130 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" } ], "type": "set" }, { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", + "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": "account owning the security group rule", + "name": "account", + "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 id of the security group rule", - "name": "ruleid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "security group name", - "name": "securitygroupname", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "account owning the security group rule", + "description": "the account associated with the tag", "name": "account", "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "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": "List network visibility and all accounts that have permissions to view this network.", - "isasync": false, - "name": "listNetworkPermissions", - "params": [ - { - "description": "Lists network permission by network ID", - "length": 255, - "name": "networkid", - "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", - "required": true, - "type": "uuid" - } - ], - "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", - "type": "string" + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" }, { - "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 ID of the domain to which the network belongs", + "description": "the domain ID of the security group", "name": "domainid", "type": "string" }, { - "description": "the name of the domain to which the network belongs", + "description": "the domain name of the security group", "name": "domain", "type": "string" }, - {}, { - "description": "the network ID", - "name": "networkid", + "description": "the name of the security group", + "name": "name", "type": "string" - } - ], - "since": "4.17.0" + }, + {} + ] }, { "description": "Removes a VM from any existing backup offering", @@ -64142,7 +64281,7 @@ "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", + "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,createVMFromBackup,createVMFromBackup,assignVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", "required": true, "type": "uuid" }, @@ -64155,30 +64294,96 @@ } ], "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.14.0" + }, + { + "description": "List network visibility and all accounts that have permissions to view this network.", + "isasync": false, + "name": "listNetworkPermissions", + "params": [ + { + "description": "Lists network permission by network ID", + "length": 255, + "name": "networkid", + "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "required": true, + "type": "uuid" + } + ], + "related": "", + "response": [ + { + "description": "the name of the domain to which the network belongs", + "name": "domain", + "type": "string" + }, + {}, + { + "description": "the ID of account the network is available for", + "name": "accountid", + "type": "string" + }, + { + "description": "the ID of project the network is available for", + "name": "projectid", + "type": "string" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + { + "description": "the account the network is available for", + "name": "account", + "type": "string" + }, {}, - {}, + { + "description": "the ID of the domain to which the network belongs", + "name": "domainid", + "type": "string" + }, + { + "description": "the project the network is available for", + "name": "project", + "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 network ID", + "name": "networkid", "type": "string" } ], - "since": "4.14.0" + "since": "4.17.0" }, { "description": "Lists site 2 site vpn gateways", @@ -64186,161 +64391,161 @@ "name": "listVpnGateways", "params": [ { - "description": "", + "description": "id of the vpn gateway", "length": 255, - "name": "pagesize", + "name": "id", + "related": "createVpnGateway,listVpnGateways,updateVpnGateway", "required": false, - "type": "integer" + "type": "uuid" }, { - "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": "activateProject,createProject,suspendProject", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "List 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 only resources belonging to the domain specified", "length": 255, - "name": "fordisplay", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "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.", + "description": "", "length": 255, - "name": "listall", + "name": "pagesize", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "id of vpc", + "description": "", "length": 255, - "name": "vpcid", - "related": "listVPCs,createVPC,listVPCs,updateVPC", + "name": "page", "required": false, - "type": "uuid" + "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" }, { - "description": "id of the vpn gateway", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "id", - "related": "createVpnGateway,listVpnGateways,updateVpnGateway", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "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": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "name": "listall", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "id of vpc", "length": 255, - "name": "projectid", - "related": "activateProject,createProject,suspendProject", + "name": "vpcid", + "related": "listVPCs,createVPC,listVPCs,updateVPC", "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" } ], "related": "createVpnGateway,updateVpnGateway", "response": [ - { - "description": "the project name", - "name": "project", - "type": "string" - }, { "description": "the project id", "name": "projectid", "type": "string" }, { - "description": "the domain id of the owner", - "name": "domainid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "is vpn gateway for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the vpn gateway ID", + "name": "id", "type": "string" }, - {}, { "description": "the public IP address", "name": "publicip", "type": "string" }, { - "description": "the vpc name of this gateway", - "name": "vpcname", + "description": "the vpc id of this gateway", + "name": "vpcid", "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", + "description": "the vpc name of this gateway", + "name": "vpcname", "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 domain name of the owner", "name": "domain", "type": "string" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "the owner", "name": "account", "type": "string" }, { - "description": "the vpc id of this gateway", - "name": "vpcid", + "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" + "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": "the project name", + "name": "project", "type": "string" + }, + { + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" } ] }, @@ -64350,9 +64555,9 @@ "name": "addNetrisProvider", "params": [ { - "description": "Netris tag for vNets", + "description": "Netris Tenant name", "length": 255, - "name": "netristag", + "name": "tenantname", "required": true, "type": "string" }, @@ -64365,16 +64570,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": "Netris provider URL", "length": 255, - "name": "tenantname", + "name": "netrisurl", "required": true, "type": "string" }, @@ -64386,37 +64591,33 @@ "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": "Password to login into Netris", "length": 255, - "name": "netrisurl", + "name": "password", "required": true, "type": "string" }, { - "description": "Netris provider name", + "description": "Username to login into Netris", "length": 255, - "name": "name", + "name": "username", "required": true, "type": "string" } ], "related": "listNetrisProviders,deleteNetrisProvider", "response": [ + {}, { - "description": "Netris provider uuid", - "name": "uuid", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Netris Provider site", + "name": "sitename", "type": "string" }, { @@ -64424,9 +64625,10 @@ "name": "name", "type": "string" }, + {}, { - "description": "Zone name to which the Netris Provider is associated with", - "name": "zonename", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -64435,30 +64637,33 @@ "type": "integer" }, { - "description": "Netris Admin tenant name", - "name": "tenantname", + "description": "Zone ID to which the Netris Provider is associated with", + "name": "zoneid", "type": "string" }, { - "description": "Zone ID to which the Netris Provider is associated with", - "name": "zoneid", + "description": "Netris Tag for vNets", + "name": "netristag", "type": "string" }, { - "description": "Netris Provider URL", - "name": "netrisurl", + "description": "Zone name to which the Netris Provider is associated with", + "name": "zonename", "type": "string" }, - {}, { - "description": "Netris Tag for vNets", - "name": "netristag", + "description": "Netris provider uuid", + "name": "uuid", "type": "string" }, - {}, { - "description": "Netris Provider site", - "name": "sitename", + "description": "Netris Admin tenant name", + "name": "tenantname", + "type": "string" + }, + { + "description": "Netris Provider URL", + "name": "netrisurl", "type": "string" } ], @@ -64469,6 +64674,13 @@ "isasync": false, "name": "moveUser", "params": [ + { + "description": "Moves the user under the specified account. If no account name is specified, it is necessary to provide an account id.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, { "description": "id of the user to be moved.", "length": 255, @@ -64477,13 +64689,6 @@ "required": true, "type": "uuid" }, - { - "description": "Moves the user under the specified account. If no account name is specified, it is necessary to provide an account id.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, { "description": "Moves the user under the specified account. If no account id is specified, it is necessary to provide an account name.", "length": 255, @@ -64494,20 +64699,14 @@ } ], "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", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, {}, @@ -64515,6 +64714,12 @@ "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" @@ -64528,33 +64733,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" } ] }, @@ -64571,18 +64776,18 @@ "type": "boolean" }, { - "description": "id of the vpn gateway", + "description": "id of the customer gateway", "length": 255, - "name": "s2svpngatewayid", - "related": "createVpnGateway,updateVpnGateway", + "name": "s2scustomergatewayid", + "related": "createVpnCustomerGateway,updateVpnCustomerGateway", "required": true, "type": "uuid" }, { - "description": "id of the customer gateway", + "description": "id of the vpn gateway", "length": 255, - "name": "s2scustomergatewayid", - "related": "createVpnCustomerGateway,updateVpnCustomerGateway", + "name": "s2svpngatewayid", + "related": "createVpnGateway,updateVpnGateway", "required": true, "type": "uuid" }, @@ -64597,36 +64802,50 @@ ], "related": "updateVpnConnection", "response": [ - {}, { - "description": "Split multiple remote networks into multiple phase 2 SAs. Often used with Cisco some products.", - "name": "splitconnections", - "type": "boolean" + "description": "IKE policy of the customer gateway", + "name": "ikepolicy", + "type": "string" }, { - "description": "the public IP address", - "name": "publicip", + "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", + "name": "ikeversion", "type": "string" }, { - "description": "the domain id of the owner", - "name": "domainid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "IPsec Preshared-Key of the customer gateway", - "name": "ipsecpsk", + "description": "public ip address id of the customer gateway", + "name": "gateway", "type": "string" }, { - "description": "the vpn gateway ID", - "name": "s2svpngatewayid", + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" + }, + { + "description": "if DPD is enabled for customer gateway", + "name": "dpd", + "type": "boolean" + }, + { + "description": "the owner", + "name": "account", + "type": "string" + }, + { + "description": "the connection ID", + "name": "id", "type": "string" }, { - "description": "is connection for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "Lifetime of ESP SA of customer gateway", + "name": "esplifetime", + "type": "long" }, { "description": "if Force NAT Encapsulation is enabled for customer gateway", @@ -64634,63 +64853,58 @@ "type": "boolean" }, { - "description": "Lifetime of ESP SA of customer gateway", - "name": "esplifetime", - "type": "long" - }, - { - "description": "State of vpn connection", - "name": "state", + "description": "the domain id of the owner", + "name": "domainid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Lifetime of IKE SA of customer gateway", + "name": "ikelifetime", + "type": "long" }, { - "description": "public ip address id of the customer gateway", - "name": "gateway", + "description": "ESP policy of the customer gateway", + "name": "esppolicy", "type": "string" }, { - "description": "if DPD is enabled for customer gateway", - "name": "dpd", + "description": "Split multiple remote networks into multiple phase 2 SAs. Often used with Cisco some products.", + "name": "splitconnections", "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": "IPsec Preshared-Key of the customer gateway", + "name": "ipsecpsk", "type": "string" }, { - "description": "the owner", - "name": "account", + "description": "the domain path of the owner", + "name": "domainpath", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the customer gateway ID", + "name": "s2scustomergatewayid", "type": "string" }, { - "description": "the connection ID", - "name": "id", + "description": "the project name", + "name": "project", "type": "string" }, { - "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", + "description": "the public IP address", + "name": "publicip", "type": "string" }, { @@ -64699,28 +64913,24 @@ "type": "date" }, { - "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 domain name of the owner", + "name": "domain", + "type": "string" }, { - "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", - "name": "ikeversion", + "description": "State of vpn connection", + "name": "state", "type": "string" }, + {}, { - "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": "the domain path of the owner", - "name": "domainpath", + "description": "the project id", + "name": "projectid", "type": "string" }, { @@ -64728,17 +64938,12 @@ "name": "passive", "type": "boolean" }, + {}, { - "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", - "type": "string" - }, - { - "description": "the domain name of the owner", - "name": "domain", - "type": "string" - }, - {} + "description": "is connection for display to the regular user", + "name": "fordisplay", + "type": "boolean" + } ] }, { @@ -64747,25 +64952,25 @@ "name": "listBrocadeVcsDeviceNetworks", "params": [ { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { "description": "brocade vcs switch ID", @@ -64779,182 +64984,140 @@ "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", "response": [ { - "description": "the type of the network", - "name": "type", + "description": "true if network offering is ip conserve mode enabled", + "name": "networkofferingconservemode", + "type": "boolean" + }, + { + "description": "path of the Domain the network belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the domain name of the network owner", - "name": "domain", + "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 IPv4 DNS for the network", + "name": "dns2", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the type of the network", + "name": "type", + "type": "string" }, { - "description": "path of the Domain the network belongs to", - "name": "domainpath", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { - "description": "the domain id of the network owner", - "name": "domainid", + "description": "the ID of the Network associated with this private gateway", + "name": "associatednetworkid", "type": "string" }, { - "description": "true if network can span multiple zones", - "name": "strechedl2subnet", - "type": "boolean" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "true if guest network default egress policy is allow; false if default egress policy is deny", - "name": "egressdefaultpolicy", - "type": "boolean" + "description": "the details of the network", + "name": "details", + "type": "map" }, { - "description": "the name of the network", - "name": "name", + "description": "display text of the network offering the network is created from", + "name": "networkofferingdisplaytext", "type": "string" }, { - "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", - "name": "cidr", + "description": "true if network supports specifying ip ranges, false otherwise", + "name": "specifyipranges", + "type": "boolean" + }, + { + "description": "ACL Id associated with the VPC network", + "name": "aclid", "type": "string" }, { - "description": "availability of the network offering the network is created from", - "name": "networkofferingavailability", + "description": "the owner of the network", + "name": "account", "type": "string" }, { - "description": "MTU configured on the network VR's private interfaces", - "name": "privatemtu", - "type": "integer" + "description": "true if guest network default egress policy is allow; false if default egress policy is deny", + "name": "egressdefaultpolicy", + "type": "boolean" }, + {}, { - "description": "zone id of the network", - "name": "zoneid", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the name of the zone the network belongs to", - "name": "zonename", - "type": "string" + "description": "true if network is system, false otherwise", + "name": "issystem", + "type": "boolean" }, { - "description": "the id of the network", - "name": "id", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the network's gateway", + "name": "gateway", "type": "string" }, { - "description": "true if network supports specifying vlan, false otherwise", - "name": "specifyvlan", - "type": "boolean" + "description": "the domain id of the network owner", + "name": "domainid", + "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "ACL name associated with the VPC network", + "name": "aclname", + "type": "string" }, - {}, { - "description": "the ID of the Network associated with this private gateway", - "name": "associatednetworkid", + "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", + "name": "cidr", "type": "string" }, { - "description": "the displaytext of the network", - "name": "displaytext", + "description": "The external id of the network", + "name": "externalid", "type": "string" }, { - "description": "Name of the VPC to which this network belongs", - "name": "vpcname", - "type": "string" + "description": "list networks that are persistent", + "name": "ispersistent", + "type": "boolean" }, { - "description": "the list of resource tags associated with network", - "name": "tags", - "response": [ - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "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": "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": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - } - ], - "type": "list" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "MTU configured on the network VR's public facing interfaces", - "name": "publicmtu", - "type": "integer" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the second IPv6 DNS for the network", - "name": "ip6dns2", + "description": "network offering id the network is created from", + "name": "networkofferingid", "type": "string" }, { - "description": "the first IPv4 DNS for the network", - "name": "dns1", - "type": "string" + "description": "AS NUMBER", + "name": "asnumber", + "type": "long" }, { "description": "the physical network id", @@ -64962,84 +65125,99 @@ "type": "string" }, { - "description": "if network offering supports vm autoscaling feature", - "name": "supportsvmautoscaling", - "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": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "Tungsten-Fabric virtual router the network belongs to", - "name": "tungstenvirtualrouteruuid", + "description": "state of the network", + "name": "state", "type": "string" }, { - "description": "VPC the network belongs to", - "name": "vpcid", + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" + }, + { + "description": "Broadcast domain type of the network", + "name": "broadcastdomaintype", "type": "string" }, { - "description": "true if network supports specifying ip ranges, false otherwise", - "name": "specifyipranges", - "type": "boolean" + "description": "the traffic type of the network", + "name": "traffictype", + "type": "string" }, { - "description": "The IPv4 routing type of network", - "name": "ip4routing", + "description": "name of the network offering the network is created from", + "name": "networkofferingname", "type": "string" }, { - "description": "AS NUMBER", - "name": "asnumber", - "type": "long" + "description": "The BGP peers for the network", + "name": "bgppeers", + "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": "true if users from subdomains can access the domain level network", - "name": "subdomainaccess", + "description": "true if network supports specifying vlan, false otherwise", + "name": "specifyvlan", "type": "boolean" }, { - "description": "true network requires restart", - "name": "restartrequired", - "type": "boolean" + "description": "The vlan of the network. This parameter is visible to ROOT admins only", + "name": "vlan", + "type": "string" }, { - "description": "true if network is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the displaytext of the network", + "name": "displaytext", + "type": "string" }, { - "description": "the second IPv4 DNS for the network", - "name": "dns2", + "description": "the first IPv6 DNS for the network", + "name": "ip6dns1", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The Ipv6 routing type of network offering", + "name": "ip6routing", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "MTU configured on the network VR's public facing interfaces", + "name": "publicmtu", + "type": "integer" + }, + { + "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 network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes", - "name": "reservediprange", + "description": "related to what other network configuration", + "name": "related", "type": "string" }, { - "description": "The vlan of the network. This parameter is visible to ROOT admins only", - "name": "vlan", + "description": "the first IPv4 DNS for the network", + "name": "dns1", + "type": "string" + }, + { + "description": "The internet protocol of network offering", + "name": "internetprotocol", "type": "string" }, { @@ -65048,70 +65226,85 @@ "type": "string" }, { - "description": "display text of the network offering the network is created from", - "name": "networkofferingdisplaytext", + "description": "true if network is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", + "name": "broadcasturi", "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "UUID of AS NUMBER", + "name": "asnumberid", "type": "string" }, { - "description": "ACL name associated with the VPC network", - "name": "aclname", + "description": "the name of the network", + "name": "name", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "availability of the network offering the network is created from", + "name": "networkofferingavailability", + "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "the name of the zone the network belongs to", + "name": "zonename", "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 network's netmask", + "name": "netmask", "type": "string" }, { - "description": "the details of the network", - "name": "details", - "type": "map" + "description": "If the network has redundant routers enabled", + "name": "redundantrouter", + "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": "VPC the network belongs to", + "name": "vpcid", "type": "string" }, { - "description": "UUID of AS NUMBER", - "name": "asnumberid", + "description": "Name of the VPC to which this network belongs", + "name": "vpcname", "type": "string" }, { - "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", - "name": "broadcasturi", + "description": "zone id of the network", + "name": "zoneid", "type": "string" }, { - "description": "the owner of the network", - "name": "account", + "description": "the second IPv6 DNS for the network", + "name": "ip6dns2", "type": "string" }, { - "description": "the traffic type of the network", - "name": "traffictype", + "description": "acl type - access type to the network", + "name": "acltype", "type": "string" }, { - "description": "related to what other network configuration", - "name": "related", + "description": "the project name of the address", + "name": "project", "type": "string" }, + { + "description": "the date this network was created", + "name": "created", + "type": "date" + }, { "description": "the list of services", "name": "service", @@ -65122,27 +65315,39 @@ "type": "string" }, { - "description": "the service provider name", - "name": "provider", + "description": "the list of capabilities", + "name": "capability", "response": [ { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", + "description": "the capability value", + "name": "value", "type": "string" }, { - "description": "state of the network provider", - "name": "state", - "type": "string" + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" }, { - "description": "services for this provider", - "name": "servicelist", - "type": "list" + "description": "the capability 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": "uuid of the network provider", - "name": "id", + "description": "the provider name", + "name": "name", "type": "string" }, { @@ -65151,36 +65356,24 @@ "type": "string" }, { - "description": "the provider name", - "name": "name", + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", "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": "services for this provider", + "name": "servicelist", + "type": "list" }, { - "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" + "description": "uuid of the network provider", + "name": "id", + "type": "string" } ], "type": "list" @@ -65189,118 +65382,130 @@ "type": "list" }, { - "description": "The internet protocol of network offering", - "name": "internetprotocol", - "type": "string" + "description": "true if network can span multiple zones", + "name": "strechedl2subnet", + "type": "boolean" }, { - "description": "The BGP peers for the network", - "name": "bgppeers", + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip4routes", "type": "set" }, { - "description": "the network's gateway", - "name": "gateway", - "type": "string" - }, - { - "description": "acl type - access type to the network", - "name": "acltype", - "type": "string" - }, - { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "The Ipv6 routing type of network offering", - "name": "ip6routing", - "type": "string" - }, - { - "description": "ACL Id associated with the VPC network", - "name": "aclid", - "type": "string" + "description": "true network requires restart", + "name": "restartrequired", + "type": "boolean" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "an optional field, whether to the display the network to the end user or not.", - "name": "displaynetwork", + "description": "list networks available for vm deployment", + "name": "canusefordeploy", "type": "boolean" }, { - "description": "name of the network offering the network is created from", - "name": "networkofferingname", + "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": "true if users from subdomains can access the domain level network", + "name": "subdomainaccess", + "type": "boolean" }, { - "description": "network offering id the network is created from", - "name": "networkofferingid", + "description": "Tungsten-Fabric virtual router the network belongs to", + "name": "tungstenvirtualrouteruuid", "type": "string" }, { - "description": "true if network offering is ip conserve mode enabled", - "name": "networkofferingconservemode", - "type": "boolean" - }, - { - "description": "the network's netmask", - "name": "netmask", + "description": "the id of the network", + "name": "id", "type": "string" }, { - "description": "list networks that are persistent", - "name": "ispersistent", + "description": "an optional field, whether to the display the network to the end user or not.", + "name": "displaynetwork", "type": "boolean" }, { - "description": "true if network is system, false otherwise", - "name": "issystem", + "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": "ip4routes", - "type": "set" + "description": "the list of resource tags associated with network", + "name": "tags", + "response": [ + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the 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": "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 domain associated with the tag", + "name": "domain", + "type": "string" + } + ], + "type": "list" }, { - "description": "state of the network", - "name": "state", + "description": "the domain name of the network owner", + "name": "domain", "type": "string" }, { - "description": "If the network has redundant routers enabled", - "name": "redundantrouter", - "type": "boolean" - }, - { - "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", - "name": "zonesnetworkspans", - "type": "set" - }, - { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip6routes", - "type": "set" - }, - { - "description": "list networks available for vm deployment", - "name": "canusefordeploy", - "type": "boolean" - }, - { - "description": "the first IPv6 DNS for the network", - "name": "ip6dns1", + "description": "The IPv4 routing type of network", + "name": "ip4routing", "type": "string" } ] @@ -65330,18 +65535,18 @@ "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.21.0" }, @@ -65351,11 +65556,11 @@ "name": "listWebhookDeliveries", "params": [ { - "description": "List by keyword", + "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.", "length": 255, - "name": "keyword", + "name": "enddate", "required": false, - "type": "string" + "type": "date" }, { "description": "The ID of the management server", @@ -65366,34 +65571,33 @@ "type": "uuid" }, { - "description": "The end date range for the Webhook delivery (use format \"yyyy-MM-dd\" or \"yyyy-MM-dd HH:mm:ss\"). All deliveries having end date equal to or before the specified date will be listed.", + "description": "The ID of the Webhook delivery", "length": 255, - "name": "enddate", + "name": "id", + "related": "", "required": false, - "type": "date" + "type": "uuid" }, { - "description": "", + "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": "page", + "name": "startdate", "required": false, - "type": "integer" + "type": "date" }, { - "description": "The ID of the Webhook delivery", + "description": "List by keyword", "length": 255, - "name": "id", - "related": "", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "The ID of the Webhook", + "description": "", "length": 255, - "name": "webhookid", - "related": "createWebhook,listWebhookDeliveries", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { "description": "The event type of the Webhook delivery", @@ -65403,81 +65607,78 @@ "type": "string" }, { - "description": "The start date range for the Webhook delivery (use format \"yyyy-MM-dd\" or \"yyyy-MM-dd HH:mm:ss\"). All deliveries having start date equal to or after the specified date will be listed.", + "description": "", "length": 255, - "name": "startdate", + "name": "page", "required": false, - "type": "date" + "type": "integer" }, { - "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 project id of the Kubernetes cluster", + "name": "projectid", "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 ID of the domain in which the Webhook exists", - "name": "domainid", + "description": "The description of the Webhook", + "name": "description", "type": "string" }, { - "description": "The description of the Webhook", - "name": "description", + "description": "path of the domain to which the Webhook belongs", + "name": "domainpath", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "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 payload URL end point for the Webhook", + "name": "payloadurl", + "type": "string" }, { - "description": "The name of the domain in which the Webhook exists", - "name": "domain", + "description": "the project name of the Kubernetes cluster", + "name": "project", "type": "string" }, { - "description": "the project id of the Kubernetes cluster", - "name": "projectid", + "description": "The name of the Webhook", + "name": "name", "type": "string" }, + {}, { "description": "The account associated with the Webhook", "name": "account", "type": "string" }, + {}, { - "description": "The state of the Webhook", - "name": "state", + "description": "The ID of the domain in which the Webhook exists", + "name": "domainid", "type": "string" }, { - "description": "The date when this Webhook was created", - "name": "created", - "type": "date" - }, - { - "description": "The ID of the Webhook", - "name": "id", + "description": "The state of the Webhook", + "name": "state", "type": "string" }, { @@ -65486,25 +65687,29 @@ "type": "string" }, { - "description": "The scope of the Webhook", - "name": "scope", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "path of the domain to which the Webhook belongs", - "name": "domainpath", + "description": "The name of the domain in which the Webhook exists", + "name": "domain", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The scope of the Webhook", + "name": "scope", "type": "string" }, { - "description": "the project name of the Kubernetes cluster", - "name": "project", + "description": "The ID of the Webhook", + "name": "id", "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ], "since": "4.20.0" @@ -65514,14 +65719,6 @@ "isasync": true, "name": "dedicateHost", "params": [ - { - "description": "the ID of the containing domain", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", - "required": true, - "type": "uuid" - }, { "description": "the name of the account which needs dedication. Must be used with domainId.", "length": 255, @@ -65533,7 +65730,15 @@ "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" + }, + { + "description": "the ID of the containing domain", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": true, "type": "uuid" } @@ -65541,19 +65746,18 @@ "related": "listDedicatedHosts", "response": [ { - "description": "the ID of the host", - "name": "hostid", + "description": "the Dedication Affinity Group ID of the host", + "name": "affinitygroupid", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the host", + "name": "hostname", "type": "string" }, { - "description": "the ID of the dedicated resource", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -65561,26 +65765,27 @@ "name": "accountid", "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 Dedication Affinity Group ID of the host", - "name": "affinitygroupid", + "description": "the domain ID of the host", + "name": "domainid", "type": "string" }, + {}, { - "description": "the name of the host", - "name": "hostname", + "description": "the ID of the host", + "name": "hostid", "type": "string" }, { - "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" } ] }, @@ -65589,13 +65794,6 @@ "isasync": false, "name": "listStorageAccessGroups", "params": [ - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, { "description": "Name of the Storage access group", "length": 255, @@ -65604,11 +65802,11 @@ "type": "string" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { "description": "", @@ -65616,33 +65814,36 @@ "name": "page", "required": false, "type": "integer" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" } ], "related": "", "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, { "description": "the 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 Zones in the Storage Access Group", + "name": "zones", "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", + "description": "List of Clusters in the Storage Access Group", + "name": "clusters", "type": "listresponse" }, { @@ -65651,22 +65852,26 @@ "type": "listresponse" }, { - "description": "List of Zones in the Storage Access Group", - "name": "zones", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "List of Storage Pools in the Storage Access Group", + "name": "storagepools", "type": "listresponse" }, {}, { - "description": "List of Clusters in the Storage Access Group", - "name": "clusters", + "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" - }, - {} + "description": "the name of the storage access group", + "name": "name", + "type": "string" + } ], "since": "4.21.0" }, @@ -65676,16 +65881,16 @@ "name": "addGloboDnsHost", "params": [ { - "description": "Password for GloboDNS", + "description": "Username for GloboDNS", "length": 255, - "name": "password", + "name": "username", "required": true, "type": "string" }, { - "description": "Username for GloboDNS", + "description": "GloboDNS url", "length": 255, - "name": "username", + "name": "url", "required": true, "type": "string" }, @@ -65698,36 +65903,36 @@ "type": "uuid" }, { - "description": "GloboDNS url", + "description": "Password for GloboDNS", "length": 255, - "name": "url", + "name": "password", "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": "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" }, @@ -65738,11 +65943,6 @@ "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", @@ -65750,6 +65950,11 @@ "type": "string" }, {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "Response description", "name": "description", @@ -65762,6 +65967,13 @@ "isasync": false, "name": "importRole", "params": [ + { + "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": "Force create a role with the same name. This overrides the role type, description and rule permissions for the existing role. Default is false.", "length": 255, @@ -65770,18 +65982,18 @@ "type": "boolean" }, { - "description": "The type of the role, valid options are: Admin, ResourceAdmin, DomainAdmin, User", + "description": "Creates a role with this unique name", "length": 255, - "name": "type", - "required": false, + "name": "name", + "required": true, "type": "string" }, { - "description": "Rules param list, rule and permission is must. Example: rules[0].rule=create*&rules[0].permission=allow&rules[0].description=create%20rule&rules[1].rule=list*&rules[1].permission=allow&rules[1].description=listing", + "description": "The type of the role, valid options are: Admin, ResourceAdmin, DomainAdmin, User", "length": 255, - "name": "rules", - "required": true, - "type": "map" + "name": "type", + "required": false, + "type": "string" }, { "description": "The description of the role", @@ -65790,13 +66002,6 @@ "required": false, "type": "string" }, - { - "description": "Creates a role with this unique name", - "length": 255, - "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, @@ -65808,52 +66013,52 @@ "related": "createRole,listRoles,updateRole", "response": [ { - "description": "the name of the role", - "name": "name", - "type": "string" - }, - { - "description": "the type of the role", - "name": "type", - "type": "string" + "description": "true if role is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, - {}, { "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 role", + "name": "id", + "type": "string" + }, { "description": "the description of the role", "name": "description", "type": "string" }, { - "description": "the state of the role", - "name": "state", + "description": "the type of the role", + "name": "type", "type": "string" }, { - "description": "the ID of the role", - "name": "id", + "description": "the state of the role", + "name": "state", "type": "string" }, { - "description": "true if role is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "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 UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } + {}, + {} ], "since": "4.15.0" }, @@ -65869,13 +66074,6 @@ "required": true, "type": "string" }, - { - "description": "The quota email template subject, max: 77 characters", - "length": 77, - "name": "templatesubject", - "required": true, - "type": "string" - }, { "description": "The locale of the email text", "length": 255, @@ -65883,6 +66081,13 @@ "required": false, "type": "string" }, + { + "description": "The quota email template subject, max: 77 characters", + "length": 77, + "name": "templatesubject", + "required": true, + "type": "string" + }, { "description": "The quota email template body, max: 500k characters", "length": 512000, @@ -65898,21 +66103,21 @@ "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, {}, + {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, - {}, { - "description": "the UUID of the latest async 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.7.0" @@ -65923,33 +66128,33 @@ "name": "quotaCreditsList", "params": [ { - "description": "Start date of the credit statement. If not provided, the first day of the current month will be considered as the start date. The recommended format is \"yyyy-MM-dd'T'HH:mm:ssZ\" (e.g.: \"2023-01-01T12:00:00+0100\"); however, the following formats are also accepted: \"yyyy-MM-dd HH:mm:ss\" (e.g.: \"2023-01-01 12:00:00\") and \"yyyy-MM-dd\" (e.g.: \"2023-01-01\" - if the time is not added, it will be interpreted as \"00:00:00\"). If the recommended format is not used, the date will be considered in the server timezone.", + "description": "End date of the credit statement. If not provided, the current date will be considered as the end date. The recommended format is \"yyyy-MM-dd'T'HH:mm:ssZ\" (e.g.: \"2023-01-01T12:00:00+0100\"); however, the following formats are also accepted: \"yyyy-MM-dd HH:mm:ss\" (e.g.: \"2023-01-01 12:00:00\") and \"yyyy-MM-dd\" (e.g.: \"2023-01-01\" - if the time is not added, it will be interpreted as \"23:59:59\"). If the recommended format is not used, the date will be considered in the server timezone.", "length": 255, - "name": "startdate", + "name": "enddate", "required": false, "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.", + "description": "Start date of the credit statement. If not provided, the first day of the current month will be considered as the start date. The recommended format is \"yyyy-MM-dd'T'HH:mm:ssZ\" (e.g.: \"2023-01-01T12:00:00+0100\"); however, the following formats are also accepted: \"yyyy-MM-dd HH:mm:ss\" (e.g.: \"2023-01-01 12:00:00\") and \"yyyy-MM-dd\" (e.g.: \"2023-01-01\" - if the time is not added, it will be interpreted as \"00:00:00\"). If the recommended format is not used, the date will be considered in the server timezone.", "length": 255, - "name": "enddate", + "name": "startdate", "required": false, "type": "date" }, { - "description": "ID of the account for which the credit statement will be generated.", + "description": "Whether to generate the credit statement for the provided domain and its children. Defaults to false.", "length": 255, - "name": "accountid", - "related": "disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", + "name": "isrecursive", "required": false, - "type": "uuid" + "type": "boolean" }, { "description": "ID of the domain for which credit statement will be generated. Available only for administrators.", @@ -65962,43 +66167,43 @@ ], "related": "quotaCredits", "response": [ - {}, { "description": "The credit deposited.", "name": "credit", "type": "bigdecimal" }, { - "description": "Credit's currency.", - "name": "currency", - "type": "string" + "description": "When the credit was added.", + "name": "creditedon", + "type": "date" }, { "description": "Username of the creditor user.", "name": "creditorusername", "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": "Credit's currency.", + "name": "currency", + "type": "string" + }, {}, { "description": "ID of the creditor user.", "name": "creditoruserid", "type": "string" }, - { - "description": "When the credit was added.", - "name": "creditedon", - "type": "date" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } + {} ], "since": "4.21.0" }, @@ -66007,13 +66212,6 @@ "isasync": true, "name": "restartSharedFileSystem", "params": [ - { - "description": "is cleanup required", - "length": 255, - "name": "cleanup", - "required": false, - "type": "boolean" - }, { "description": "the ID of the shared filesystem", "length": 255, @@ -66021,12 +66219,24 @@ "related": "listSharedFileSystems,startSharedFileSystem,stopSharedFileSystem,changeSharedFileSystemDiskOffering,changeSharedFileSystemServiceOffering", "required": true, "type": "uuid" + }, + { + "description": "is cleanup required", + "length": 255, + "name": "cleanup", + "required": false, + "type": "boolean" } ], "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" }, { @@ -66034,18 +66244,13 @@ "name": "jobstatus", "type": "integer" }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, + {}, {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - {} + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } ], "since": "4.20.0" }, @@ -66055,19 +66260,12 @@ "name": "listNetworkServiceProviders", "params": [ { - "description": "list providers by name", + "description": "list providers by state", "length": 255, - "name": "name", + "name": "state", "required": false, "type": "string" }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, { "description": "the Physical Network ID", "length": 255, @@ -66077,9 +66275,9 @@ "type": "uuid" }, { - "description": "list providers by state", + "description": "List by keyword", "length": 255, - "name": "state", + "name": "keyword", "required": false, "type": "string" }, @@ -66091,40 +66289,42 @@ "type": "integer" }, { - "description": "List by keyword", + "description": "list providers by name", "length": 255, - "name": "keyword", + "name": "name", "required": false, "type": "string" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" } ], - "related": "addNetworkServiceProvider,listTrafficTypes", + "related": "addNetworkServiceProvider", "response": [ + {}, {}, { - "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": "uuid of the network provider", - "name": "id", - "type": "string" + "description": "services for this provider", + "name": "servicelist", + "type": "list" }, { "description": "state of the network provider", "name": "state", "type": "string" }, - {}, - { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" - }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "uuid of the network provider", + "name": "id", "type": "string" }, { @@ -66133,19 +66333,24 @@ "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", + "type": "string" }, { "description": "true if individual services can be enabled/disabled", "name": "canenableindividualservice", "type": "boolean" + }, + { + "description": "the provider name", + "name": "name", + "type": "string" + }, + { + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", + "type": "string" } ], "since": "3.0.0" @@ -66156,43 +66361,43 @@ "name": "deleteTungstenFabricTagType", "params": [ { - "description": "the ID of zone", + "description": "the ID of Tungsten-Fabric tag type", "length": 255, - "name": "zoneid", - "related": "createZone,listZones", + "name": "tagtypeuuid", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "the ID of Tungsten-Fabric tag type", + "description": "the ID of zone", "length": 255, - "name": "tagtypeuuid", + "name": "zoneid", + "related": "createZone,listZones", "required": true, - "type": "string" + "type": "uuid" } ], "response": [ - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, {}, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" + }, + { + "description": "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" } ] }, @@ -66212,6 +66417,11 @@ ], "response": [ {}, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -66223,11 +66433,6 @@ "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 +66457,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": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" } ] }, @@ -66284,33 +66489,33 @@ "description": "The ID of the disk volume", "length": 255, "name": "id", - "related": "createVolume,updateVolume,listVolumes,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", + "related": "importVolume,createVolume,updateVolume,listVolumes,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", "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 UUID of the latest async 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" + }, {} ] }, @@ -66319,6 +66524,13 @@ "isasync": false, "name": "updateSecondaryStorageSelector", "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 unique identifier of the secondary storage selector.", "length": 255, @@ -66326,69 +66538,62 @@ "related": "listSecondaryStorageSelectors,updateSecondaryStorageSelector", "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" } ], "related": "listSecondaryStorageSelectors", "response": [ + {}, { - "description": "Name of the heuristic.", - "name": "name", + "description": "ID of the heuristic.", + "name": "id", "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", + "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" }, - { - "description": "When the heuristic was created.", - "name": "created", - "type": "date" - }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "Description of the heuristic.", - "name": "description", + "description": "The zone which the heuristic is valid upon.", + "name": "zoneid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "When the heuristic was removed.", + "name": "removed", + "type": "date" }, { - "description": "The zone which the heuristic is valid upon.", - "name": "zoneid", + "description": "The heuristic rule, in JavaScript language, used to select a secondary storage to be directed.", + "name": "heuristicrule", "type": "string" }, { - "description": "ID of the heuristic.", - "name": "id", + "description": "Name of the heuristic.", + "name": "name", "type": "string" }, - {} + { + "description": "When the heuristic 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.19.0" }, @@ -66409,33 +66614,29 @@ "related": "createUser,disableUser,getUser,listUsers,lockUser", "response": [ { - "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 account ID of the user", - "name": "accountid", + "description": "the name of the role", + "name": "rolename", "type": "string" }, { - "description": "the account name of the user", - "name": "account", + "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 type of the role", + "name": "roletype", + "type": "string" }, + {}, { - "description": "true if user has two factor authentication is mandated", - "name": "is2famandated", + "description": "true if user is default, false otherwise", + "name": "isdefault", "type": "boolean" }, { @@ -66444,23 +66645,43 @@ "type": "boolean" }, { - "description": "the timezone user was created in", - "name": "timezone", + "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 user email address", + "name": "email", + "type": "string" + }, + { + "description": "the account ID of the user", + "name": "accountid", "type": "string" }, + { + "description": "true if user has two factor authentication is mandated", + "name": "is2famandated", + "type": "boolean" + }, { "description": "the source type of the user in lowercase, such as native, ldap, saml2", "name": "usersource", "type": "string" }, { - "description": "the user firstname", - "name": "firstname", + "description": "the user lastname", + "name": "lastname", "type": "string" }, { - "description": "the user email address", - "name": "email", + "description": "the account name of the user", + "name": "account", "type": "string" }, { @@ -66468,25 +66689,25 @@ "name": "accounttype", "type": "integer" }, - {}, { "description": "the user ID", "name": "id", "type": "string" }, + {}, { - "description": "the user lastname", - "name": "lastname", + "description": "the domain ID of the user", + "name": "domainid", "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "the user firstname", + "name": "firstname", "type": "string" }, { - "description": "the secret key of the user", - "name": "secretkey", + "description": "the timezone user was created in", + "name": "timezone", "type": "string" }, { @@ -66494,40 +66715,29 @@ "name": "apikeyaccess", "type": "apikeyaccess" }, - { - "description": "the domain ID of the user", - "name": "domainid", - "type": "string" - }, - {}, - { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, { "description": "the domain name of the user", "name": "domain", "type": "string" }, { - "description": "the user name", - "name": "username", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the name of the role", - "name": "rolename", + "description": "the user state", + "name": "state", "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 api key of the user", - "name": "apikey", + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { @@ -66536,13 +66746,8 @@ "type": "date" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the user state", - "name": "state", + "description": "the api key of the user", + "name": "apikey", "type": "string" } ] @@ -66560,18 +66765,18 @@ "type": "string" }, { - "description": "The end date of the quota tariff. If not informed, the tariff will be valid indefinitely. The recommended format is \"yyyy-MM-dd'T'HH:mm:ssZ\" (e.g.: \"2023-01-01T12:00:00+0100\"); however, the following formats are also accepted: \"yyyy-MM-dd HH:mm:ss\" (e.g.: \"2023-01-01 12:00:00\") and \"yyyy-MM-dd\" (e.g.: \"2023-01-01\" - if the time is not added, it will be interpreted as \"23:59:59\"). If the recommended format is not used, the date will be considered in the server timezone.", + "description": "The effective start date on/after which the quota tariff is effective. Inform null to use the current date. The recommended format is \"yyyy-MM-dd'T'HH:mm:ssZ\" (e.g.: \"2023-01-01T12:00:00+0100\"); however, the following formats are also accepted: \"yyyy-MM-dd HH:mm:ss\" (e.g.: \"2023-01-01 12:00:00\") and \"yyyy-MM-dd\" (e.g.: \"2023-01-01\" - if the time is not added, it will be interpreted as \"00:00:00\"). If the recommended format is not used, the date will be considered in the server timezone.", "length": 255, - "name": "enddate", + "name": "startdate", "required": false, "type": "date" }, { - "description": "Quota tariff's activation rule. It can receive a JS script that results in either a boolean or a numeric value: if it results in a boolean value, the tariff value will be applied according to the result; if it results in a numeric value, the numeric value will be applied; if the result is neither a boolean nor a numeric value, the tariff will not be applied. If the rule is not informed, the tariff value will be applied.", - "length": 65535, - "name": "activationrule", - "required": false, - "type": "string" + "description": "Integer value for the usage type of the resource.", + "length": 255, + "name": "usagetype", + "required": true, + "type": "integer" }, { "description": "The quota tariff value of the resource as per the default unit.", @@ -66581,46 +66786,55 @@ "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.", - "length": 255, - "name": "startdate", - "required": false, - "type": "date" + "description": "Quota tariff's name", + "length": 65535, + "name": "name", + "required": true, + "type": "string" }, { - "description": "Position in the execution sequence for tariffs of the same type", + "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": "position", + "name": "enddate", "required": false, - "since": "4.20.0.0", - "type": "integer" + "type": "date" }, { - "description": "Quota tariff's name", + "description": "Quota tariff's activation rule. It can receive a JS script that results in either a boolean or a numeric value: if it results in a boolean value, the tariff value will be applied according to the result; if it results in a numeric value, the numeric value will be applied; if the result is neither a boolean nor a numeric value, the tariff will not be applied. If the rule is not informed, the tariff value will be applied.", "length": 65535, - "name": "name", - "required": true, + "name": "activationrule", + "required": false, "type": "string" }, { - "description": "Integer value for the usage type of the resource.", + "description": "Position in the execution sequence for tariffs of the same type", "length": 255, - "name": "usagetype", - "required": true, + "name": "position", + "required": false, + "since": "4.20.0.0", "type": "integer" } ], "related": "quotaTariffList", "response": [ - {}, + { + "description": "usageType", + "name": "usageType", + "type": "int" + }, + { + "description": "name", + "name": "name", + "type": "string" + }, { "description": "description", "name": "description", "type": "string" }, { - "description": "activation rule of the quota tariff", - "name": "activationRule", + "description": "usageName", + "name": "usageName", "type": "string" }, { @@ -66629,74 +66843,65 @@ "type": "string" }, { - "description": "usage type description", - "name": "usageTypeDescription", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "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", "name": "jobstatus", "type": "integer" }, + {}, { - "description": "usageUnit", - "name": "usageUnit", + "description": "usage type description", + "name": "usageTypeDescription", "type": "string" }, { - "description": "name", - "name": "name", - "type": "string" + "description": "when the quota tariff was removed", + "name": "removed", + "type": "date" }, { - "description": "currency", - "name": "currency", + "description": "usageUnit", + "name": "usageUnit", "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": "the ID of the tariff", + "name": "id", + "type": "string" + }, { "description": "tariffValue", "name": "tariffValue", "type": "bigdecimal" }, { - "description": "when the quota tariff was removed", - "name": "removed", - "type": "date" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the end date of the quota tariff", - "name": "endDate", + "description": "the start date of the quota tariff", + "name": "effectiveDate", "type": "date" }, { - "description": "usageName", - "name": "usageName", + "description": "activation rule of the quota tariff", + "name": "activationRule", "type": "string" } ], @@ -66719,48 +66924,53 @@ "related": "activateProject,createProject", "response": [ { - "description": "the total memory (in MB) available to be created for this project", - "name": "memoryavailable", + "description": "the total number of public ip addresses available for this project to acquire", + "name": "ipavailable", "type": "string" }, { - "description": "the total number of vpcs owned by project", - "name": "vpctotal", + "description": "the total number of templates which have been created by this project", + "name": "templatetotal", "type": "long" }, { - "description": "the total number of public ip addresses this project can acquire", - "name": "iplimit", - "type": "string" + "description": "the total number of virtual machines stopped for this project", + "name": "vmstopped", + "type": "integer" }, { - "description": "the total number of backups which can be stored by this project", - "name": "backuplimit", - "type": "string" + "description": "the total number of buckets stored by this project", + "name": "buckettotal", + "type": "long" }, { - "description": "the total number of networks the project can own", - "name": "networklimit", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the 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 buckets which can be stored by this project", - "name": "bucketlimit", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the total number of cpu cores the project can own", - "name": "cpulimit", + "description": "the total volume available for this project", + "name": "volumeavailable", "type": "string" }, { - "description": "the total memory (in MB) the project can own", - "name": "memorylimit", + "description": "the total object storage space (in GiB) available to the project", + "name": "objectstorageavailable", + "type": "string" + }, + { + "description": "the total number of public ip addresses this project can acquire", + "name": "iplimit", "type": "string" }, { @@ -66769,8 +66979,13 @@ "type": "string" }, { - "description": "the total number of backups stored by this project", - "name": "backuptotal", + "description": "the total backup storage space (in GiB) available to the project", + "name": "backupstorageavailable", + "type": "string" + }, + { + "description": "the total object storage space (in GiB) owned by the project", + "name": "objectstoragetotal", "type": "long" }, { @@ -66779,166 +66994,108 @@ "type": "string" }, { - "description": "the name of the project", - "name": "name", - "type": "string" + "description": "the total secondary storage space (in GiB) owned by project", + "name": "secondarystoragetotal", + "type": "float" }, { - "description": "the total memory (in MB) owned by project", - "name": "memorytotal", - "type": "long" + "description": "the id of the project", + "name": "id", + "type": "string" }, { - "description": "The tagged resource limit and count for the project", - "name": "taggedresources", - "type": "list" + "description": "the total number of vpcs available to be created for this project", + "name": "vpcavailable", + "type": "string" }, { - "description": "the project account name of the project", - "name": "projectaccountname", + "description": "the displaytext of the project", + "name": "displaytext", "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) available to be used for this project", + "name": "primarystorageavailable", "type": "string" }, { - "description": "the list of resource tags associated with vm", - "name": "tags", - "response": [ - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - } - ], - "type": "list" + "description": "the total number of snapshots stored by this project", + "name": "snapshottotal", + "type": "long" }, { - "description": "the domain name where the project belongs to", - "name": "domain", - "type": "string" + "description": "the total memory (in MB) owned by project", + "name": "memorytotal", + "type": "long" }, { - "description": "the total number of templates which can be created by this project", - "name": "templatelimit", + "description": "the total memory (in MB) available to be created for this project", + "name": "memoryavailable", "type": "string" }, { - "description": "the total secondary storage space (in GiB) owned by project", - "name": "secondarystoragetotal", - "type": "float" + "description": "the total number of virtual machines running for this project", + "name": "vmrunning", + "type": "integer" }, { - "description": "the total volume being used by this project", - "name": "volumetotal", - "type": "long" + "description": "the total number of vpcs the project can own", + "name": "vpclimit", + "type": "string" }, { - "description": "the total number of cpu cores owned by project", - "name": "cputotal", - "type": "long" + "description": "the total number of backups available to this project", + "name": "backupavailable", + "type": "string" }, - {}, { - "description": "the date this project was created", - "name": "created", - "type": "date" + "description": "the account name of the project's owners", + "name": "owner", + "type": "list" }, { - "description": "the total volume which can be used by this project", - "name": "volumelimit", + "description": "the total number of buckets which can be stored by this project", + "name": "bucketlimit", "type": "string" }, { - "description": "the total number of public ip addresses allocated for this project", - "name": "iptotal", - "type": "long" + "description": "the date this project was created", + "name": "created", + "type": "date" }, { - "description": "the total number of cpu cores available to be created for this project", - "name": "cpuavailable", - "type": "string" + "description": "the total volume being used by this project", + "name": "volumetotal", + "type": "long" }, { - "description": "the total number of snapshots which can be stored by this project", - "name": "snapshotlimit", + "description": "the total number of networks available to be created for this project", + "name": "networkavailable", "type": "string" }, { - "description": "the total number of vpcs the project can own", - "name": "vpclimit", - "type": "string" + "description": "the total number of vpcs owned by project", + "name": "vpctotal", + "type": "long" }, { - "description": "the total number of snapshots stored by this project", - "name": "snapshottotal", + "description": "the total primary storage space (in GiB) owned by project", + "name": "primarystoragetotal", "type": "long" }, { - "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 secondary storage space (in GiB) the project can own", - "name": "secondarystoragelimit", + "description": "the total volume which can be used by this project", + "name": "volumelimit", "type": "string" }, { - "description": "the total object storage space (in GiB) owned by the project", - "name": "objectstoragetotal", + "description": "the total number of backups stored by this project", + "name": "backuptotal", "type": "long" }, { @@ -66947,54 +67104,116 @@ "type": "long" }, { - "description": "the total primary storage space (in GiB) owned by project", - "name": "primarystoragetotal", - "type": "long" + "description": "the state of the project", + "name": "state", + "type": "string" }, { - "description": "the total number of virtual machines that can be deployed by this project", - "name": "vmlimit", + "description": "the total secondary storage space (in GiB) available to be used for this project", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "the total number of networks available to be created for this project", - "name": "networkavailable", + "description": "the total number of networks the project can own", + "name": "networklimit", "type": "string" }, { - "description": "the total secondary storage space (in GiB) available to be used for this project", - "name": "secondarystorageavailable", + "description": "the total memory (in MB) the project can own", + "name": "memorylimit", "type": "string" }, { - "description": "the state of the project", - "name": "state", + "description": "the total number of virtual machines that can be deployed by this project", + "name": "vmlimit", "type": "string" }, { - "description": "the total volume available for this project", - "name": "volumeavailable", + "description": "the total number of snapshots available for this project", + "name": "snapshotavailable", "type": "string" }, { - "description": "the account name of the project's owners", - "name": "owner", + "description": "the total number of public ip addresses allocated for this project", + "name": "iptotal", + "type": "long" + }, + { + "description": "the list of resource tags associated with vm", + "name": "tags", + "response": [ + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "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 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": "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": "id of the resource", + "name": "resourceid", + "type": "string" + } + ], "type": "list" }, {}, { - "description": "the total number of templates which have been created by this project", - "name": "templatetotal", - "type": "long" + "description": "the total number of cpu cores available to be created for this project", + "name": "cpuavailable", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the total number of virtual machines deployed by this project", + "name": "vmtotal", + "type": "long" }, { - "description": "the total number of virtual machines available for this project to acquire", - "name": "vmavailable", + "description": "the domain id the project belongs to", + "name": "domainid", "type": "string" }, { @@ -67003,69 +67222,70 @@ "type": "string" }, { - "description": "the total number of public ip addresses available for this project to acquire", - "name": "ipavailable", + "description": "the total number of templates which can be created by this project", + "name": "templatelimit", "type": "string" }, { - "description": "the total number of buckets available to this project", - "name": "bucketavailable", + "description": "the total number of snapshots which can be stored by this project", + "name": "snapshotlimit", "type": "string" }, { - "description": "the total backup storage space (in GiB) available to the project", - "name": "backupstorageavailable", + "description": "the total number of cpu cores the project can own", + "name": "cpulimit", "type": "string" }, { - "description": "the displaytext of the project", - "name": "displaytext", + "description": "the total secondary storage space (in GiB) the project can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "the total number of backups available to this project", - "name": "backupavailable", + "description": "the total number of gpus available to be created for this project", + "name": "gpuavailable", "type": "string" }, { - "description": "the total object storage space (in GiB) available to the project", - "name": "objectstorageavailable", - "type": "string" + "description": "the total number of networks owned by project", + "name": "networktotal", + "type": "long" }, { - "description": "the total number of snapshots available for this project", - "name": "snapshotavailable", + "description": "the total number of virtual machines available for this project to acquire", + "name": "vmavailable", "type": "string" }, + {}, { - "description": "the total number of gpus owned by project", - "name": "gputotal", + "description": "the total number of cpu cores owned by project", + "name": "cputotal", "type": "long" }, { - "description": "the total number of virtual machines stopped for this project", - "name": "vmstopped", - "type": "integer" + "description": "the project account name of the project", + "name": "projectaccountname", + "type": "string" }, { - "description": "the total number of gpus available to be created for this project", - "name": "gpuavailable", + "description": "the domain name where the project belongs to", + "name": "domain", "type": "string" }, { - "description": "the total primary storage space (in GiB) available to be used for this project", - "name": "primarystorageavailable", - "type": "string" + "description": "the total number of gpus owned by project", + "name": "gputotal", + "type": "long" }, { - "description": "the domain id the project belongs to", - "name": "domainid", + "description": "the total number of backups which can be stored by this project", + "name": "backuplimit", "type": "string" }, { - "description": "the id of the project", - "name": "id", - "type": "string" + "description": "The tagged resource limit and count for the project", + "name": "taggedresources", + "type": "list" }, { "description": "the total object storage space (in GiB) the project can own", @@ -67078,24 +67298,9 @@ "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the total number of buckets stored by this project", - "name": "buckettotal", - "type": "long" - }, - { - "description": "the total number of virtual machines running for this project", - "name": "vmrunning", - "type": "integer" - }, - { - "description": "the total number of networks owned by project", - "name": "networktotal", - "type": "long" + "description": "the total number of buckets available to this project", + "name": "bucketavailable", + "type": "string" } ], "since": "3.0.0" @@ -67107,6 +67312,16 @@ "params": [], "related": "", "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "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,32 +67332,22 @@ "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", - "type": "long" - }, {}, { - "description": "the account uuid of the api remaining count", - "name": "accountid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "seconds left to reset counters", + "name": "expireAfter", + "type": "long" } ] }, @@ -67167,11 +67372,7 @@ "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", @@ -67182,7 +67383,11 @@ "name": "success", "type": "boolean" }, - {} + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } ], "since": "3.0.0" }, @@ -67192,33 +67397,19 @@ "name": "addVmwareDc", "params": [ { - "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": true, - "type": "string" - }, - { - "description": "The Username required to connect to resource.", + "description": "The password for specified username.", "length": 255, - "name": "username", + "name": "password", "required": false, "type": "string" }, { - "description": "Name of VMware datacenter to be added to specified zone.", + "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": "name", + "name": "vcenter", "required": true, "type": "string" }, - { - "description": "The password for specified username.", - "length": 255, - "name": "password", - "required": false, - "type": "string" - }, { "description": "The Zone ID.", "length": 255, @@ -67226,41 +67417,55 @@ "related": "createZone,listZones", "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 VMware Datacenter ID", - "name": "id", + "description": "The Username required to connect to resource.", + "length": 255, + "name": "username", + "required": false, "type": "string" }, { - "description": "The VMware Datacenter name", + "description": "Name of VMware datacenter to be added to specified zone.", + "length": 255, "name": "name", + "required": true, "type": "string" - }, + } + ], + "related": "", + "response": [ { "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 Zone ID associated with this VMware Datacenter", "name": "zoneid", "type": "long" + }, + { + "description": "The VMware Datacenter ID", + "name": "id", + "type": "string" + }, + { + "description": "The VMware Datacenter name", + "name": "name", + "type": "string" } ] }, @@ -67270,25 +67475,18 @@ "name": "updateIpv6FirewallRule", "params": [ { - "description": "the ending port of Ipv6 firewall rule", - "length": 255, - "name": "endport", - "required": false, - "type": "integer" - }, - { - "description": "type of the ICMP message being sent", + "description": "the traffic type for the Ipv6 firewall rule, can be Ingress or Egress, defaulted to Ingress if not specified", "length": 255, - "name": "icmptype", + "name": "traffictype", "required": false, - "type": "integer" + "type": "string" }, { - "description": "error code for this ICMP message", + "description": "the cidr list to allow traffic from/to. Multiple entries must be separated by a single comma character (,).", "length": 255, - "name": "icmpcode", + "name": "cidrlist", "required": false, - "type": "integer" + "type": "list" }, { "description": "the protocol for the Ipv6 firewall rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number", @@ -67306,12 +67504,11 @@ "type": "boolean" }, { - "description": "the ID of the ipv6 firewall rule", + "description": "error code for this ICMP message", "length": 255, - "name": "id", - "related": "listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,updateIpv6FirewallRule", - "required": true, - "type": "uuid" + "name": "icmpcode", + "required": false, + "type": "integer" }, { "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", @@ -67322,78 +67519,45 @@ "type": "string" }, { - "description": "the cidr list to allow traffic from/to. Multiple entries must be separated by a single comma character (,).", + "description": "the starting port of Ipv6 firewall rule", "length": 255, - "name": "cidrlist", + "name": "startport", "required": false, - "type": "list" + "type": "integer" }, { - "description": "the traffic type for the Ipv6 firewall rule, can be Ingress or Egress, defaulted to Ingress if not specified", + "description": "the ID of the ipv6 firewall rule", "length": 255, - "name": "traffictype", + "name": "id", + "related": "listRoutingFirewallRules,updateIpv6FirewallRule,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule", + "required": true, + "type": "uuid" + }, + { + "description": "the ending port of Ipv6 firewall rule", + "length": 255, + "name": "endport", "required": false, - "type": "string" + "type": "integer" }, { - "description": "the starting port of Ipv6 firewall rule", + "description": "type of the ICMP message being sent", "length": 255, - "name": "startport", + "name": "icmptype", "required": false, "type": "integer" } ], "related": "listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule", "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", - "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 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 vm ip address for the port forwarding rule", - "name": "vmguestip", - "type": "string" - }, - { - "description": "the ID of the port forwarding rule", - "name": "id", + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { - "description": "the VM ID for the port forwarding rule", - "name": "virtualmachineid", + "description": "the VM name for the port forwarding rule", + "name": "virtualmachinename", "type": "string" }, { @@ -67406,23 +67570,28 @@ "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": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -67431,8 +67600,8 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { @@ -67440,33 +67609,33 @@ "name": "key", "type": "string" }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, { "description": "the domain associated with the tag", "name": "domain", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "list" }, + { + "description": "the public ip address for the port forwarding rule", + "name": "ipaddress", + "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 vm ip address for the port forwarding rule", + "name": "vmguestip", + "type": "string" }, { "description": "the protocol of the port forwarding rule", @@ -67474,26 +67643,62 @@ "type": "string" }, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "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": "privateendport", + "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", + "description": "the ID of the port forwarding rule", + "name": "id", + "type": "string" + }, + { + "description": "the starting port of port forwarding rule's private port range", + "name": "privateport", + "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 VM display name for the port forwarding rule", + "name": "virtualmachinedisplayname", + "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", + "type": "string" + }, + { + "description": "is firewall for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + {}, { "description": "the starting port of port forwarding rule's public port range", "name": "publicport", @@ -67507,33 +67712,41 @@ "name": "updateIsoPermissions", "params": [ { - "description": "a comma delimited list of accounts within caller's domain. If specified, \"op\" parameter has to be passed in.", + "description": "true if the template/iso is extractable, false other wise. Can be set only by root admin", "length": 255, - "name": "accounts", + "name": "isextractable", "required": false, - "type": "list" + "type": "boolean" + }, + { + "description": "true for featured template/iso, false otherwise", + "length": 255, + "name": "isfeatured", + "required": false, + "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": true, "type": "uuid" }, { - "description": "true for featured template/iso, false otherwise", + "description": "a comma delimited list of accounts within caller's domain. If specified, \"op\" parameter has to be passed in.", "length": 255, - "name": "isfeatured", + "name": "accounts", "required": false, - "type": "boolean" + "type": "list" }, { - "description": "true for public template/iso, false for private templates/isos", + "description": "a comma delimited list of projects. If specified, \"op\" parameter has to be passed in.", "length": 255, - "name": "ispublic", + "name": "projectids", + "related": "activateProject,createProject", "required": false, - "type": "boolean" + "type": "list" }, { "description": "permission operator (add, remove, reset)", @@ -67543,44 +67756,36 @@ "type": "string" }, { - "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" - }, - { - "description": "a comma delimited list of projects. If specified, \"op\" parameter has to be passed in.", - "length": 255, - "name": "projectids", - "related": "activateProject,createProject", - "required": false, - "type": "list" } ], "response": [ - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "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" + } ] }, { @@ -67603,23 +67808,23 @@ "name": "success", "type": "boolean" }, + {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" - }, - {} + } ] }, { @@ -67638,26 +67843,26 @@ ], "response": [ { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, - {}, { "description": "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" } ] }, @@ -67669,17 +67874,10 @@ { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, { "description": "the zone ID", "length": 255, @@ -67688,10 +67886,17 @@ "required": false, "type": "uuid" }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" } @@ -67699,9 +67904,9 @@ "related": "", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Created date", + "name": "created", + "type": "date" }, {}, { @@ -67709,30 +67914,30 @@ "name": "jobid", "type": "string" }, - { - "description": "Start AS Number", - "name": "startasn", - "type": "long" - }, { "description": "Zone ID", "name": "zoneid", "type": "string" }, { - "description": "End AS Number", - "name": "endasn", + "description": "Start AS Number", + "name": "startasn", "type": "long" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "ID of the AS Number Range", "name": "id", "type": "string" }, { - "description": "Created date", - "name": "created", - "type": "date" + "description": "End AS Number", + "name": "endasn", + "type": "long" }, {} ], @@ -67744,16 +67949,16 @@ "name": "createTungstenFabricTag", "params": [ { - "description": "Tungsten-Fabric tag value", + "description": "Tungsten-Fabric tag type", "length": 255, - "name": "tagvalue", + "name": "tagtype", "required": true, "type": "string" }, { - "description": "Tungsten-Fabric tag type", + "description": "Tungsten-Fabric tag value", "length": 255, - "name": "tagtype", + "name": "tagvalue", "required": true, "type": "string" }, @@ -67774,9 +67979,14 @@ "type": "string" }, { - "description": "list Tungsten-Fabric network", - "name": "network", - "type": "list" + "description": "Tungsten-Fabric tag type uuid", + "name": "uuid", + "type": "string" + }, + { + "description": "Tungsten-Fabric tag name", + "name": "name", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", @@ -67784,40 +67994,35 @@ "type": "integer" }, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", - "type": "string" + "description": "list Tungsten-Fabric vm", + "name": "vm", + "type": "list" }, { - "description": "Tungsten-Fabric tag type uuid", - "name": "uuid", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, - {}, - {}, { "description": "list Tungsten-Fabric nic", "name": "nic", "type": "list" }, + {}, { "description": "Tungsten-Fabric provider zone id", "name": "zoneid", "type": "long" }, { - "description": "list Tungsten-Fabric vm", - "name": "vm", + "description": "list Tungsten-Fabric policy", + "name": "policy", "type": "list" }, + {}, { - "description": "Tungsten-Fabric tag name", - "name": "name", - "type": "string" - }, - { - "description": "list Tungsten-Fabric policy", - "name": "policy", + "description": "list Tungsten-Fabric network", + "name": "network", "type": "list" } ] @@ -67827,13 +68032,6 @@ "isasync": true, "name": "addOpenDaylightController", "params": [ - { - "description": "Credential to access the OpenDaylight API", - "length": 255, - "name": "password", - "required": true, - "type": "string" - }, { "description": "Username to access the OpenDaylight API", "length": 255, @@ -67842,9 +68040,9 @@ "type": "string" }, { - "description": "Api URL of the OpenDaylight Controller.", + "description": "Credential to access the OpenDaylight API", "length": 255, - "name": "url", + "name": "password", "required": true, "type": "string" }, @@ -67855,28 +68053,42 @@ "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", "required": true, "type": "uuid" + }, + { + "description": "Api URL of the OpenDaylight Controller.", + "length": 255, + "name": "url", + "required": true, + "type": "string" } ], "related": "deleteOpenDaylightController", "response": [ + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "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" }, { - "description": "the name assigned to the controller", - "name": "name", + "description": "the username to authenticate to the controller", + "name": "username", "type": "string" }, { - "description": "the physical network to which this controller belongs to", - "name": "physicalnetworkid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -67884,18 +68096,11 @@ "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", + "description": "the name assigned to the controller", + "name": "name", "type": "string" - }, - {} + } ] }, { @@ -67904,38 +68109,31 @@ "name": "createZone", "params": [ { - "description": "the second DNS for the Zone", + "description": "the ID of the containing domain, null for public zones", "length": 255, - "name": "dns2", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "Network domain name for the networks in the zone", + "description": "Allocation state of this Zone for allocation of new resources", "length": 255, - "name": "domain", + "name": "allocationstate", "required": false, "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 second DNS for the Zone", "length": 255, - "name": "internaldns2", + "name": "dns2", "required": false, "type": "string" }, { - "description": "the first DNS for IPv6 network in the Zone", + "description": "Network domain name for the networks in the zone", "length": 255, - "name": "ip6dns1", + "name": "domain", "required": false, "type": "string" }, @@ -67948,33 +68146,32 @@ "type": "boolean" }, { - "description": "the ID of the containing domain, null for public zones", + "description": "true if local storage offering enabled, false otherwise", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "name": "localstorageenabled", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "the second DNS for IPv6 network in the Zone", + "description": "network type of the zone, can be Basic or Advanced", "length": 255, - "name": "ip6dns2", - "required": false, + "name": "networktype", + "required": true, "type": "string" }, { - "description": "Allocation state of this Zone for allocation of new resources", + "description": "the name of the Zone", "length": 255, - "name": "allocationstate", - "required": false, + "name": "name", + "required": true, "type": "string" }, { - "description": "true if network is security group enabled, false otherwise", + "description": "the first DNS for IPv6 network in the Zone", "length": 255, - "name": "securitygroupenabled", + "name": "ip6dns1", "required": false, - "type": "boolean" + "type": "string" }, { "description": "the first DNS for the Zone", @@ -67983,6 +68180,13 @@ "required": true, "type": "string" }, + { + "description": "true if network is security group enabled, false otherwise", + "length": 255, + "name": "securitygroupenabled", + "required": false, + "type": "boolean" + }, { "description": "the guest CIDR address for the Zone", "length": 255, @@ -67991,65 +68195,51 @@ "type": "string" }, { - "description": "network type of the zone, can be Basic or Advanced", + "description": "the first internal DNS for the Zone", "length": 255, - "name": "networktype", + "name": "internaldns1", "required": true, "type": "string" }, { - "description": "the name of the Zone", + "description": "the second internal DNS for the Zone", "length": 255, - "name": "name", - "required": true, + "name": "internaldns2", + "required": false, "type": "string" }, { - "description": "true if local storage offering enabled, false otherwise", + "description": "the second DNS for IPv6 network in the Zone", "length": 255, - "name": "localstorageenabled", + "name": "ip6dns2", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "the first internal DNS for the Zone", + "description": "comma separated list of storage access groups for the hosts in the zone", "length": 255, - "name": "internaldns1", - "required": true, - "type": "string" + "name": "storageaccessgroups", + "required": false, + "since": "4.21.0", + "type": "list" } ], "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", + "description": "the UUID of the containing domain, null for public zones", + "name": "domainid", "type": "string" }, { - "description": "Allow end users to specify VR MTU", - "name": "allowuserspecifyvrmtu", - "type": "boolean" - }, - { - "description": "true if security groups support is enabled, false otherwise", - "name": "securitygroupsenabled", - "type": "boolean" + "description": "the second DNS for the Zone", + "name": "dns2", + "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "comma-separated list of storage access groups for the zone", + "name": "storageaccessgroups", + "type": "string" }, { "description": "the first DNS for the Zone", @@ -68057,50 +68247,40 @@ "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", - "type": "string" - }, - { - "description": "comma-separated list of storage access groups for the zone", - "name": "storageaccessgroups", + "description": "Zone description", + "name": "description", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the first IPv6 DNS for the Zone", + "name": "ip6dns1", "type": "string" }, - {}, { - "description": "The maximum value the MTU can have on the VR's public interfaces", - "name": "routerpublicinterfacemaxmtu", - "type": "integer" + "description": "Meta data associated with the zone (key/value pairs)", + "name": "resourcedetails", + "type": "map" }, { - "description": "Zone id", - "name": "id", + "description": "the type of the zone - core or edge", + "name": "type", "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", + "description": "true if local storage offering enabled, false otherwise", + "name": "localstorageenabled", "type": "boolean" }, { - "description": "Used GPUs in the Zone", - "name": "gpuused", - "type": "long" + "description": "true, if zone contains clusters and hosts from different CPU architectures", + "name": "ismultiarch", + "type": "boolean" }, { "description": "the name of the containing domain, null for public zones", @@ -68108,239 +68288,264 @@ "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the network type of the zone; can be Basic or Advanced", - "name": "networktype", + "description": "the allocation state of the cluster", + "name": "allocationstate", "type": "string" }, { - "description": "External network provider if any", - "name": "provider", + "description": "Zone Token", + "name": "zonetoken", "type": "string" }, {}, { - "description": "Zone Token", - "name": "zonetoken", + "description": "Zone name", + "name": "name", "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 first IPv6 DNS for the Zone", - "name": "ip6dns1", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the display text of the zone", - "name": "displaytext", - "type": "string" + "description": "The maximum value the MTU can have on the VR's private interfaces", + "name": "routerprivateinterfacemaxmtu", + "type": "integer" }, { - "description": "the dhcp Provider for the Zone", - "name": "dhcpprovider", + "description": "the display text of the zone", + "name": "displaytext", "type": "string" }, { - "description": "true if local storage offering enabled, false otherwise", - "name": "localstorageenabled", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the allocation state of the cluster", - "name": "allocationstate", - "type": "string" - }, - { - "description": "the type of the zone - core or edge", - "name": "type", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the first internal DNS for the Zone", - "name": "internaldns1", - "type": "string" + "description": "Allow end users to specify VR MTU", + "name": "allowuserspecifyvrmtu", + "type": "boolean" }, { - "description": "Zone description", - "name": "description", + "description": "the second IPv6 DNS for the Zone", + "name": "ip6dns2", "type": "string" }, { - "description": "the second internal DNS for the Zone", - "name": "internaldns2", - "type": "string" + "description": "Total GPUs in the Zone", + "name": "gputotal", + "type": "long" }, { - "description": "AS Number Range", - "name": "asnrange", + "description": "the guest CIDR address for the Zone", + "name": "guestcidraddress", "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", + "description": "the percentage of capacity currently in use", + "name": "percentused", "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 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 Zone name", + "name": "zonename", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the Pod name", + "name": "podname", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the Cluster ID", + "name": "clusterid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the Cluster name", + "name": "clustername", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the capacity name", + "name": "name", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "The tag for the capacity type", + "name": "tag", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the total capacity available", + "name": "capacitytotal", + "type": "long" + }, + { + "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 Zone ID", + "name": "zoneid", "type": "string" } ], - "type": "set" + "type": "list" }, { - "description": "Zone name", - "name": "name", + "description": "Zone id", + "name": "id", "type": "string" }, { - "description": "the second DNS for the Zone", - "name": "dns2", - "type": "string" + "description": "true if security groups support is enabled, false otherwise", + "name": "securitygroupsenabled", + "type": "boolean" }, { - "description": "the capacity of the Zone", - "name": "capacity", + "description": "Used GPUs in the Zone", + "name": "gpuused", + "type": "long" + }, + { + "description": "the list of resource tags associated with zone.", + "name": "tags", "response": [ { - "description": "the Pod name", - "name": "podname", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the total capacity available", - "name": "capacitytotal", - "type": "long" - }, - { - "description": "the Zone ID", - "name": "zoneid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the percentage of capacity currently in use", - "name": "percentused", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the capacity type", - "name": "type", - "type": "short" - }, - { - "description": "the Pod ID", - "name": "podid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the capacity currently in use", - "name": "capacityused", - "type": "long" + "description": "customer associated with the tag", + "name": "customer", + "type": "string" }, { - "description": "the Zone name", - "name": "zonename", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the Cluster ID", - "name": "clusterid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the capacity currently in allocated", - "name": "capacityallocated", - "type": "long" + "description": "tag key name", + "name": "key", + "type": "string" }, { - "description": "the Cluster name", - "name": "clustername", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "The tag for the capacity type", - "name": "tag", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the capacity name", - "name": "name", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" } ], - "type": "list" - }, - { - "description": "the guest CIDR address for the Zone", - "name": "guestcidraddress", - "type": "string" + "type": "set" }, { "description": "true, if routed network/vpc is enabled", "name": "routedmodeenabled", "type": "boolean" + }, + { + "description": "true, if zone is NSX enabled", + "name": "isnsxenabled", + "type": "boolean" + }, + { + "description": "the second internal DNS for the Zone", + "name": "internaldns2", + "type": "string" + }, + { + "description": "External network provider if any", + "name": "provider", + "type": "string" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "AS Number Range", + "name": "asnrange", + "type": "string" + }, + { + "description": "The maximum value the MTU can have on the VR's public interfaces", + "name": "routerpublicinterfacemaxmtu", + "type": "integer" + }, + { + "description": "the network type of the zone; can be Basic or Advanced", + "name": "networktype", + "type": "string" + }, + { + "description": "the dhcp Provider for the Zone", + "name": "dhcpprovider", + "type": "string" + }, + { + "description": "the first internal DNS for the Zone", + "name": "internaldns1", + "type": "string" } ] }, @@ -68349,13 +68554,6 @@ "isasync": false, "name": "listDomainChildren", "params": [ - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, { "description": "", "length": 255, @@ -68363,13 +68561,6 @@ "required": false, "type": "integer" }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, { "description": "flag to display the resource icon for domains", "length": 255, @@ -68384,6 +68575,13 @@ "required": false, "type": "string" }, + { + "description": "to return the entire tree, use the value \"true\". To return the first level children, use the value \"false\".", + "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", "length": 255, @@ -68392,11 +68590,18 @@ "type": "boolean" }, { - "description": "to return the entire tree, use the value \"true\". To return the first level children, use the value \"false\".", + "description": "List by keyword", "length": 255, - "name": "isrecursive", + "name": "keyword", "required": false, - "type": "boolean" + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { "description": "list children domain by parent domain ID.", @@ -68410,53 +68615,33 @@ "related": "createDomain,listDomains,listDomains,moveDomain", "response": [ { - "description": "the total volume being used by this domain", - "name": "volumetotal", + "description": "the total number of cpu cores owned by domain", + "name": "cputotal", "type": "long" }, { - "description": "the name of the domain", - "name": "name", + "description": "the total number of public ip addresses this domain can acquire", + "name": "iplimit", "type": "string" }, { - "description": "the domain name of the parent domain", - "name": "parentdomainname", + "description": "the total number of projects available for administration by this domain", + "name": "projectavailable", "type": "string" }, { - "description": "the total number of templates which have been created by this domain", - "name": "templatetotal", - "type": "long" - }, - { - "description": "the level of the domain", - "name": "level", - "type": "integer" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "The tagged resource limit and count for the domain", - "name": "taggedresources", - "type": "list" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total number of templates which can be created by this domain", + "name": "templatelimit", "type": "string" }, { - "description": "the total backup storage space (in GiB) owned by the domain", - "name": "backupstoragetotal", - "type": "long" + "description": "the domain ID of the parent domain", + "name": "parentdomainid", + "type": "string" }, { - "description": "the total primary storage space (in GiB) available to be used for this domain", - "name": "primarystorageavailable", + "description": "the total number of templates available to be created by this domain", + "name": "templateavailable", "type": "string" }, { @@ -68465,48 +68650,53 @@ "type": "long" }, { - "description": "the total number of templates available to be created by this domain", - "name": "templateavailable", + "description": "the total backup storage space (in GiB) the domain can own", + "name": "backupstoragelimit", "type": "string" }, { - "description": "the total number of gpus owned by domain", - "name": "gputotal", + "description": "the total number of vpcs owned by domain", + "name": "vpctotal", "type": "long" }, { - "description": "the total memory (in MB) owned by domain", - "name": "memorytotal", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the ID of the domain", - "name": "id", + "description": "the total memory (in MB) the domain can own", + "name": "memorylimit", "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 object storage space (in GiB) available to the domain", - "name": "objectstorageavailable", + "description": "the total number of virtual machines deployed by this domain", + "name": "vmtotal", + "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 snapshots which can be stored by this domain", - "name": "snapshotlimit", + "description": "the name of the domain", + "name": "name", "type": "string" }, { - "description": "the total number of backups which can be stored by this domain", - "name": "backuplimit", + "description": "the total number of gpus available to be created for this domain", + "name": "gpuavailable", "type": "string" }, { - "description": "the total number of virtual machines available for this domain to acquire", - "name": "vmavailable", + "description": "the total primary storage space (in GiB) available to be used for this domain", + "name": "primarystorageavailable", "type": "string" }, { @@ -68515,38 +68705,29 @@ "type": "string" }, { - "description": "the total number of virtual machines that can be deployed by this domain", - "name": "vmlimit", + "description": "the total number of public ip addresses available for this domain to acquire", + "name": "ipavailable", "type": "string" }, { - "description": "details for the domain", - "name": "domaindetails", - "type": "map" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the total number of public ip addresses allocated for this domain", - "name": "iptotal", - "type": "long" + "description": "the total number of buckets which can be stored by this domain", + "name": "bucketlimit", + "type": "string" }, { - "description": "the total memory (in MB) available to be created for this domain", - "name": "memoryavailable", + "description": "the total backup storage space (in GiB) available to the domain", + "name": "backupstorageavailable", "type": "string" }, { - "description": "whether the domain has one or more sub-domains", - "name": "haschild", - "type": "boolean" + "description": "the ID of the domain", + "name": "id", + "type": "string" }, + {}, { - "description": "the total volume available for this domain", - "name": "volumeavailable", + "description": "the total number of virtual machines that can be deployed by this domain", + "name": "vmlimit", "type": "string" }, { @@ -68554,107 +68735,105 @@ "name": "snapshotavailable", "type": "string" }, - {}, { - "description": "the total number of templates which can be created by this domain", - "name": "templatelimit", + "description": "the total memory (in MB) available to be created for this domain", + "name": "memoryavailable", "type": "string" }, { - "description": "the total number of projects available for administration by this domain", - "name": "projectavailable", + "description": "the state of the domain", + "name": "state", "type": "string" }, { - "description": "the total number of networks owned by domain", - "name": "networktotal", + "description": "the total number of buckets stored by this domain", + "name": "buckettotal", "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) the domain can own", "name": "objectstoragelimit", "type": "string" }, { - "description": "the total number of gpus available to be created for this domain", - "name": "gpuavailable", - "type": "string" + "description": "the total number of gpus owned by domain", + "name": "gputotal", + "type": "long" }, { - "description": "the total backup storage space (in GiB) available to the domain", - "name": "backupstorageavailable", + "description": "the domain name of the parent domain", + "name": "parentdomainname", "type": "string" }, { - "description": "the total number of vpcs owned by domain", - "name": "vpctotal", - "type": "long" + "description": "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 networks owned by domain", + "name": "networktotal", + "type": "long" }, { - "description": "the state of the domain", - "name": "state", + "description": "the total number of gpus the domain can own", + "name": "gpulimit", "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" }, { - "description": "the total number of projects the domain can own", - "name": "projectlimit", - "type": "string" + "description": "the total number of templates which have been created by this domain", + "name": "templatetotal", + "type": "long" }, { - "description": "the date when this domain was created", - "name": "created", - "type": "date" + "description": "details for the domain", + "name": "domaindetails", + "type": "map" }, { - "description": "the total number of gpus the domain can own", - "name": "gpulimit", + "description": "the total number of backups available to this domain", + "name": "backupavailable", "type": "string" }, { - "description": "the total volume which can be used by this domain", - "name": "volumelimit", - "type": "string" + "description": "the total number of projects being administrated by this domain", + "name": "projecttotal", + "type": "long" }, { - "description": "the total number of public ip addresses available for this domain to acquire", - "name": "ipavailable", + "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 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 number of vpcs the domain can own", "name": "vpclimit", "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", - "type": "string" + "description": "the total memory (in MB) owned by domain", + "name": "memorytotal", + "type": "long" }, { - "description": "the total number of networks the domain can own", - "name": "networklimit", - "type": "string" + "description": "the total primary storage space (in GiB) owned by domain", + "name": "primarystoragetotal", + "type": "long" }, { "description": "the total number of networks available to be created for this domain", @@ -68662,49 +68841,64 @@ "type": "string" }, { - "description": "the total number of cpu cores available to be created for this domain", - "name": "cpuavailable", - "type": "string" + "description": "the total backup storage space (in GiB) owned by the domain", + "name": "backupstoragetotal", + "type": "long" }, { - "description": "the domain ID of the parent domain", - "name": "parentdomainid", + "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 total primary storage space (in GiB) owned by domain", - "name": "primarystoragetotal", - "type": "long" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the total number of backups available to this domain", - "name": "backupavailable", + "description": "The tagged resource limit and count for the domain", + "name": "taggedresources", + "type": "list" + }, + { + "description": "the path of the domain", + "name": "path", "type": "string" }, { - "description": "the total number of virtual machines deployed by this domain", - "name": "vmtotal", - "type": "long" + "description": "the total secondary storage space (in GiB) the domain can own", + "name": "secondarystoragelimit", + "type": "string" }, { - "description": "the total number of buckets stored by this domain", - "name": "buckettotal", - "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 number of cpu cores the domain can own", + "name": "cpulimit", + "type": "string" }, { - "description": "the total number of backups stored by this domain", - "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 vpcs available to be created for this domain", - "name": "vpcavailable", - "type": "string" + "description": "the level of the domain", + "name": "level", + "type": "integer" + }, + { + "description": "the total number of public ip addresses allocated for this domain", + "name": "iptotal", + "type": "long" }, { "description": "the total object storage space (in GiB) owned by the domain", @@ -68712,39 +68906,50 @@ "type": "long" }, { - "description": "the total secondary storage space (in GiB) the domain can own", - "name": "secondarystoragelimit", + "description": "the total number of projects the domain can own", + "name": "projectlimit", "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 total number of snapshots which can be stored by this domain", + "name": "snapshotlimit", "type": "string" }, { - "description": "the total number of projects being administrated by this domain", - "name": "projecttotal", - "type": "long" + "description": "the total number of vpcs available to be created for this domain", + "name": "vpcavailable", + "type": "string" }, { - "description": "the total memory (in MB) the domain can own", - "name": "memorylimit", + "description": "the total volume available for this domain", + "name": "volumeavailable", "type": "string" }, { - "description": "the total primary storage space (in GiB) the domain can own", - "name": "primarystoragelimit", + "description": "the total number of networks the domain can own", + "name": "networklimit", + "type": "string" + }, + { + "description": "the total object storage space (in GiB) available to the domain", + "name": "objectstorageavailable", "type": "string" + }, + { + "description": "the date when this domain was created", + "name": "created", + "type": "date" + }, + { + "description": "the total number of backups stored by this domain", + "name": "backuptotal", + "type": "long" } ] }, @@ -68757,29 +68962,29 @@ "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,createVMFromBackup,createVMFromBackup,assignVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", "required": true, "type": "uuid" } ], "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" } ] }, @@ -68788,6 +68993,14 @@ "isasync": true, "name": "assignToGlobalLoadBalancerRule", "params": [ + { + "description": "the list load balancer rules that will be assigned to global load balancer rule", + "length": 255, + "name": "loadbalancerrulelist", + "related": "listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule", + "required": true, + "type": "list" + }, { "description": "the ID of the global load balancer rule", "length": 255, @@ -68802,24 +69015,20 @@ "name": "gslblbruleweightsmap", "required": false, "type": "map" - }, - { - "description": "the list load balancer rules that will be assigned to global load balancer rule", - "length": 255, - "name": "loadbalancerrulelist", - "related": "listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule", - "required": true, - "type": "list" } ], "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", @@ -68830,11 +69039,7 @@ "name": "jobid", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } + {} ] }, { @@ -68843,23 +69048,30 @@ "name": "addImageStoreS3", "params": [ { - "description": "Socket timeout (milliseconds)", + "description": "Whether TCP keep-alive is used", "length": 255, - "name": "sockettimeout", + "name": "usetcpkeepalive", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "Signer Algorithm to use, either S3SignerType or AWSS3V4SignerType", + "description": "Use HTTPS instead of HTTP", "length": 255, - "name": "s3signer", + "name": "usehttps", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "S3 secret key", + "description": "Connection TTL (milliseconds)", "length": 255, - "name": "secretkey", + "name": "connectionttl", + "required": false, + "type": "integer" + }, + { + "description": "S3 access key", + "length": 255, + "name": "accesskey", "required": true, "type": "string" }, @@ -68871,18 +69083,11 @@ "type": "integer" }, { - "description": "S3 endpoint", - "length": 255, - "name": "endpoint", - "required": true, - "type": "string" - }, - { - "description": "Connection TTL (milliseconds)", + "description": "Signer Algorithm to use, either S3SignerType or AWSS3V4SignerType", "length": 255, - "name": "connectionttl", + "name": "s3signer", "required": false, - "type": "integer" + "type": "string" }, { "description": "Maximum number of times to retry on error", @@ -68892,30 +69097,30 @@ "type": "integer" }, { - "description": "Name of the storage bucket", + "description": "S3 endpoint", "length": 255, - "name": "bucket", + "name": "endpoint", "required": true, "type": "string" }, { - "description": "Use HTTPS instead of HTTP", + "description": "Socket timeout (milliseconds)", "length": 255, - "name": "usehttps", + "name": "sockettimeout", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "Whether TCP keep-alive is used", + "description": "Name of the storage bucket", "length": 255, - "name": "usetcpkeepalive", - "required": false, - "type": "boolean" + "name": "bucket", + "required": true, + "type": "string" }, { - "description": "S3 access key", + "description": "S3 secret key", "length": 255, - "name": "accesskey", + "name": "secretkey", "required": true, "type": "string" } @@ -68923,55 +69128,61 @@ "related": "addSecondaryStorage,addSwift,listSwifts,addImageStore,listImageStores", "response": [ { - "description": "the provider name of the image store", - "name": "providername", + "description": "the ID of the image store", + "name": "id", "type": "string" }, { - "description": "the Zone ID of the image store", - "name": "zoneid", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, + {}, { - "description": "the protocol of the image store", - "name": "protocol", - "type": "string" + "description": "defines if store is read-only", + "name": "readonly", + "type": "boolean" }, { - "description": "the Zone name of the image store", - "name": "zonename", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "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": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" + "description": "the name of the image store", + "name": "name", + "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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the provider name of the image store", + "name": "providername", "type": "string" }, { - "description": "the name of the image store", - "name": "name", + "description": "the Zone name of the image store", + "name": "zonename", "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 host", + "name": "disksizetotal", + "type": "long" + }, + { + "description": "the Zone ID of the image store", + "name": "zoneid", + "type": "string" }, { "description": "the scope of the image store", @@ -68979,21 +69190,15 @@ "type": "scopetype" }, { - "description": "the ID of the image store", - "name": "id", - "type": "string" + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" }, { "description": "the url of the image store", "name": "url", "type": "string" - }, - { - "description": "defines if store is read-only", - "name": "readonly", - "type": "boolean" - }, - {} + } ], "since": "4.7.0" }, @@ -69009,6 +69214,13 @@ "required": true, "type": "string" }, + { + "description": "Name for the uploaded certificate", + "length": 255, + "name": "name", + "required": true, + "type": "string" + }, { "description": "SSL certificate", "length": 65535, @@ -69017,39 +69229,32 @@ "type": "string" }, { - "description": "Zone to upload certificate", + "description": "(optional) the host ID to upload certificate", "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, + "name": "hostid", + "related": "addBaremetalHost,declareHostAsDegraded,listHosts,reconnectHost", + "required": false, "type": "uuid" }, { - "description": "Name for the uploaded certificate", + "description": "Zone to upload certificate", "length": 255, - "name": "name", + "name": "zoneid", + "related": "listZones", "required": true, - "type": "string" - }, - { - "description": "(optional) the host ID to upload certificate", - "length": 255, - "name": "hostid", - "related": "declareHostAsDegraded,listHosts,reconnectHost,addBaremetalHost", - "required": false, "type": "uuid" } ], "related": "listTemplateDirectDownloadCertificates", "response": [ { - "description": "the hosts where the certificate is uploaded to", - "name": "hostsmap", - "type": "list" + "description": "the hypervisor of the hosts where the certificate is uploaded", + "name": "hypervisor", + "type": "string" }, { - "description": "the zone id where the certificate is uploaded", - "name": "zoneid", + "description": "the direct download certificate id", + "name": "id", "type": "string" }, { @@ -69057,14 +69262,20 @@ "name": "serialnum", "type": "string" }, + {}, { - "description": "the direct download certificate issuer", - "name": "validity", + "description": "the hosts where the certificate is uploaded to", + "name": "hostsmap", + "type": "list" + }, + { + "description": "the zone name where the certificate is uploaded", + "name": "zonename", "type": "string" }, { - "description": "the hypervisor of the hosts where the certificate is uploaded", - "name": "hypervisor", + "description": "the direct download certificate version", + "name": "version", "type": "string" }, { @@ -69073,13 +69284,18 @@ "type": "string" }, { - "description": "the zone name where the certificate is uploaded", - "name": "zonename", + "description": "the direct download certificate issuer", + "name": "issuer", "type": "string" }, { - "description": "the direct download certificate alias", - "name": "alias", + "description": "the direct download certificate subject", + "name": "subject", + "type": "string" + }, + { + "description": "the zone id where the certificate is uploaded", + "name": "zoneid", "type": "string" }, { @@ -69088,27 +69304,16 @@ "type": "integer" }, { - "description": "the direct download certificate id", - "name": "id", - "type": "string" - }, - { - "description": "the direct download certificate subject", - "name": "subject", + "description": "the direct download certificate issuer", + "name": "validity", "type": "string" }, {}, { - "description": "the direct download certificate version", - "name": "version", - "type": "string" - }, - { - "description": "the direct download certificate issuer", - "name": "issuer", + "description": "the direct download certificate alias", + "name": "alias", "type": "string" - }, - {} + } ], "since": "4.11.0" }, @@ -69118,29 +69323,43 @@ "name": "importUnmanagedInstance", "params": [ { - "description": "import instance to the domain specified", + "description": "import instance for the project", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains,moveDomain", + "name": "projectid", + "related": "activateProject,createProject", "required": false, "type": "uuid" }, { - "description": "the ID of the template for the virtual machine", + "description": "the display name of the instance", "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": "displayname", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the cluster ID", + "description": "the host name of the instance", "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", + "name": "hostname", + "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": "the ID of the template for the virtual machine", + "length": 255, + "name": "templateid", + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "required": false, + "type": "uuid" + }, { "description": "the name of the instance as it is known to the hypervisor", "length": 255, @@ -69149,52 +69368,46 @@ "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", + "description": "VM nic to ip address mapping using keys nic, ip4Address", "length": 255, - "name": "nicnetworklist", + "name": "nicipaddresslist", "required": false, "type": "map" }, { - "description": "the display name of the instance", + "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": "displayname", + "name": "forced", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "import instance for the project", + "description": "import instance to the domain specified", "length": 255, - "name": "projectid", - "related": "activateProject,createProject", + "name": "domainid", + "related": "createDomain,listDomains,listDomains,moveDomain", "required": false, "type": "uuid" }, { - "description": "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": "vm and its volumes are allowed to migrate to different host/pool when offerings passed are incompatible with current host/pool", "length": 255, - "name": "forced", + "name": "migrateallowed", "required": false, "type": "boolean" }, { - "description": "the host name of the instance", + "description": "the cluster ID", "length": 255, - "name": "hostname", - "required": false, - "type": "string" + "name": "clusterid", + "related": "addCluster,updateCluster", + "required": true, + "type": "uuid" }, { - "description": "VM nic to ip address mapping using keys nic, ip4Address", + "description": "datadisk template to disk-offering mapping using keys disk and diskOffering", "length": 255, - "name": "nicipaddresslist", + "name": "datadiskofferinglist", "required": false, "type": "map" }, @@ -69206,253 +69419,75 @@ "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": "used to specify the custom parameters.", "length": 255, - "name": "datadiskofferinglist", + "name": "details", "required": false, "type": "map" }, { - "description": "used to specify the custom parameters.", + "description": "VM nic to network id mapping using keys nic and network", "length": 255, - "name": "details", + "name": "nicnetworklist", "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", + "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,createVMFromBackup,createVMFromBackup,assignVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "response": [ { - "description": "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", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, - { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, { "description": "true if high-availability is enabled, false otherwise", "name": "haenable", "type": "boolean" }, - { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" - }, - { - "description": "device type of the root volume", - "name": "rootdevicetype", - "type": "string" - }, - { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" - }, - { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" - }, - { - "description": "OS name of the vm", - "name": "osdisplayname", - "type": "string" - }, - { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, - { - "description": "Base64 string containing the user data", - "name": "userdata", - "type": "string" - }, - { - "description": "CPU arch of the VM", - "name": "arch", - "type": "string" - }, - { - "description": "the VM's primary IP address", - "name": "ipaddress", - "type": "string" - }, { "description": "the count of GPUs on the virtual machine", "name": "gpucount", "type": "integer" }, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", - "type": "string" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "description": "the user's name who deployed the virtual machine", - "name": "username", - "type": "string" - }, - { - "description": "State of the Service from LB rule", - "name": "servicestate", - "type": "string" - }, - { - "description": "the state of the virtual machine", - "name": "state", - "type": "string" - }, - { - "description": "the speed of each vCPU", - "name": "cpuspeed", + "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": "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", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "the video RAM size in MB", - "name": "videoram", - "type": "long" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" - }, - { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" - }, - { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { @@ -69461,18 +69496,18 @@ "type": "string" }, { - "description": "the format of the template for the virtual machine", - "name": "templateformat", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", + "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" }, { @@ -69480,191 +69515,120 @@ "name": "tags", "response": [ { - "description": "tag key name", - "name": "key", + "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": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the 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 ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the 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 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", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" - }, - { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" - }, - { - "description": "device ID of the root volume", - "name": "rootdeviceid", + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", "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", + "description": "OS name of the vm", + "name": "osdisplayname", "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 cidr of IPv6 network", - "name": "ip6cidr", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", "type": "integer" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", "type": "integer" }, { @@ -69673,33 +69637,38 @@ "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "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 type if available", + "name": "isolatedpvlantype", + "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 name of the corresponding network", - "name": "networkname", + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" }, { @@ -69708,13 +69677,8 @@ "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", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { @@ -69723,43 +69687,38 @@ "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": "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": "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", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { @@ -69768,93 +69727,140 @@ "type": "string" }, { - "description": "the ID of the nic", - "name": "id", - "type": "string" + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the IPv6 address of network", + "name": "ip6address", "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 ID of the vgpu profile to which service offering is linked", - "name": "vgpuprofileid", + "description": "the state of the virtual machine", + "name": "state", + "type": "string" + }, + { + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "type": "string" + }, + { + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", + "type": "string" + }, + {}, + {}, + { + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", + "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": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" + }, + { + "description": "the ID of the host for the virtual machine", + "name": "hostid", + "type": "string" + }, + { + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" + }, + { + "description": "the ID of the virtual machine", + "name": "id", + "type": "string" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "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 memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, + { + "description": "Base64 string containing the user data", + "name": "userdata", + "type": "string" + }, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, + { + "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": "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 domain ID of the security group", - "name": "domainid", - "type": "string" - }, - { - "description": "the project name of the group", - "name": "project", - "type": "string" - }, - { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, - { - "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 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": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -69868,73 +69874,61 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "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": "id of the resource", - "name": "resourceid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" } ], "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 code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, { "description": "the ending IP of the security group rule ", "name": "endport", "type": "integer" }, { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - } - ], - "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", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, { @@ -69943,52 +69937,49 @@ "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 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 type of the ICMP message response", "name": "icmptype", "type": "integer" }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, { "description": "account owning the security group rule", "name": "account", "type": "string" + } + ], + "type": "set" + }, + { + "description": "the name of the security group", + "name": "name", + "type": "string" + }, + { + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", + "response": [ + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "the domain associated with the tag", - "name": "domain", + "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" }, { @@ -69997,8 +69988,8 @@ "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -70007,18 +69998,8 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -70035,50 +70016,95 @@ "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" } ], "type": "set" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "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": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" } ], "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", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "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 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", "type": "string" }, { @@ -70087,8 +70113,8 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -70097,23 +70123,28 @@ "type": "string" }, { - "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 key name", - "name": "key", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" } ], "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" + }, { "description": "the domain name of the security group", "name": "domain", @@ -70125,172 +70156,180 @@ "type": "string" }, { - "description": "the name of the security group", - "name": "name", + "description": "the project id of the group", + "name": "projectid", "type": "string" }, { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" + "description": "the project name of the group", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the security group", + "name": "id", + "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" } ], "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 sent", + "name": "sentbytes", + "type": "long" }, - {}, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "Instance lease duration in days", + "name": "leaseduration", + "type": "integer" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", "type": "string" }, { - "description": "the name of the vgpu profile to which service offering is linked", - "name": "vgpuprofilename", + "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 password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "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 speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "User VM type", - "name": "vmtype", - "type": "string" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "description": "the maximum number of display heads", - "name": "maxheads", + "description": "the maximum Y resolution", + "name": "maxresolutiony", "type": "long" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "Instance lease expiry date", - "name": "leaseexpirydate", - "type": "date" + "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 pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", - "type": "string" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", - "type": "string" + "description": "the video RAM size in MB", + "name": "videoram", + "type": "long" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the name of the gpu card to which service offering is linked", - "name": "gpucardname", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" + "description": "the group ID of the virtual machine", + "name": "groupid", + "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", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "the type of the affinity group", + "name": "type", "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 project ID of the affinity group", - "name": "projectid", + "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 account owning the affinity group", - "name": "account", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" }, { @@ -70299,92 +70338,258 @@ "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", + "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "the 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": "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", - "type": "string" + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" } ], "type": "set" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "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 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": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" + }, + { + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, + { + "description": "OS type id of the vm", + "name": "ostypeid", + "type": "string" + }, + { + "description": "User VM type", + "name": "vmtype", + "type": "string" + }, + { + "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 virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, { "description": "the name of the virtual machine", "name": "name", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", + "type": "string" }, { - "description": "the maximum Y resolution", - "name": "maxresolutiony", + "description": "the account associated with the virtual machine", + "name": "account", + "type": "string" + }, + { + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", + "type": "string" + }, + { + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", "type": "long" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "the 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 gpu card to which service offering is linked", - "name": "gpucardid", + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", + "description": "the 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": "Vm 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 total number of network traffic bytes received", + "name": "receivedbytes", "type": "long" }, { - "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": "the date when this virtual machine was updated last time", - "name": "lastupdated", + "description": "the user's name who deployed the virtual machine", + "name": "username", + "type": "string" + }, + { + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", + "type": "string" + }, + { + "description": "the maximum number of display heads", + "name": "maxheads", + "type": "long" + }, + { + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + }, + { + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "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 memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" + }, + { + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, + { + "description": "the type of the template for the virtual machine", + "name": "templatetype", + "type": "string" + }, + { + "description": "Instance lease expiry date", + "name": "leaseexpirydate", "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 outgoing network traffic on the host in KiB", - "name": "networkkbswrite", + "description": "the name of the host for the virtual machine", + "name": "hostname", + "type": "string" + }, + { + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "type": "string" + }, + { + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, + { + "description": "the maximum X resolution", + "name": "maxresolutionx", "type": "long" + }, + { + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", + "type": "string" + }, + { + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + { + "description": "VNF details", + "name": "vnfdetails", + "type": "map" + }, + { + "description": "CPU arch of the VM", + "name": "arch", + "type": "string" } ], "since": "4.14.0" @@ -70404,7 +70609,6 @@ } ], "response": [ - {}, { "description": "true if operation is executed successfully", "name": "success", @@ -70425,7 +70629,8 @@ "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - } + }, + {} ], "since": "4.21.0" }, @@ -70435,33 +70640,18 @@ "name": "createPhysicalNetwork", "params": [ { - "description": "the Zone ID for the physical network", - "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, - "type": "uuid" - }, - { - "description": "the name of the physical network", - "length": 255, - "name": "name", - "required": true, - "type": "string" - }, - { - "description": "the speed for the physical network[1G/10G]", + "description": "the VLAN for the physical network", "length": 255, - "name": "networkspeed", + "name": "vlan", "required": false, "type": "string" }, { - "description": "the VLAN for the physical network", + "description": "the isolation method for the physical network[VLAN/L3/GRE]", "length": 255, - "name": "vlan", + "name": "isolationmethods", "required": false, - "type": "string" + "type": "list" }, { "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", @@ -70471,11 +70661,11 @@ "type": "string" }, { - "description": "the isolation method for the physical network[VLAN/L3/GRE]", + "description": "the name of the physical network", "length": 255, - "name": "isolationmethods", - "required": false, - "type": "list" + "name": "name", + "required": true, + "type": "string" }, { "description": "Tag the physical network", @@ -70484,6 +70674,14 @@ "required": false, "type": "list" }, + { + "description": "the Zone ID for the physical network", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" + }, { "description": "domain ID of the account owning a physical network", "length": 255, @@ -70491,38 +70689,30 @@ "related": "createDomain,listDomains,listDomains,moveDomain", "required": false, "type": "uuid" + }, + { + "description": "the speed for the physical network[1G/10G]", + "length": 255, + "name": "networkspeed", + "required": false, + "type": "string" } ], "related": "listPhysicalNetworks,updatePhysicalNetwork", "response": [ { - "description": "comma separated tag", - "name": "tags", - "type": "string" - }, - { - "description": "zone name of the physical network", - "name": "zonename", - "type": "string" - }, - { - "description": "the vlan of the physical network", - "name": "vlan", + "description": "isolation methods", + "name": "isolationmethods", "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": "the uuid of the physical network", + "name": "id", "type": "string" }, { - "description": "the uuid of the physical network", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -70530,9 +70720,10 @@ "name": "name", "type": "string" }, + {}, { - "description": "state of the physical network", - "name": "state", + "description": "comma separated tag", + "name": "tags", "type": "string" }, { @@ -70540,11 +70731,14 @@ "name": "networkspeed", "type": "string" }, - {}, - {}, { - "description": "isolation methods", - "name": "isolationmethods", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the domain id of the physical network owner", + "name": "domainid", "type": "string" }, { @@ -70553,14 +70747,25 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "zone name of the physical network", + "name": "zonename", + "type": "string" + }, + { + "description": "state of the physical network", + "name": "state", "type": "string" }, + {}, { "description": "Broadcast domain range of the physical network", "name": "broadcastdomainrange", "type": "string" + }, + { + "description": "the vlan of the physical network", + "name": "vlan", + "type": "string" } ], "since": "3.0.0" @@ -70571,56 +70776,48 @@ "name": "listAutoScaleVmGroups", "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": "activateProject,createProject", + "name": "listall", "required": false, - "type": "uuid" + "type": "boolean" }, { - "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", - "length": 255, - "name": "policyid", - "related": "listAutoScalePolicies", - "required": false, - "type": "uuid" - }, - { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "", "length": 255, - "name": "isrecursive", + "name": "page", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "list only resources belonging to the domain specified", + "description": "the ID of the autoscale vm group", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains,moveDomain", + "name": "id", + "related": "enableAutoScaleVmGroup,listAutoScaleVmGroups", "required": false, "type": "uuid" }, { - "description": "", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "page", + "name": "projectid", + "related": "activateProject,createProject", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "the name of the autoscale vmgroup", + "description": "List by keyword", "length": 255, - "name": "name", + "name": "keyword", "required": false, - "since": "4.18.0", "type": "string" }, { @@ -70632,18 +70829,10 @@ "type": "boolean" }, { - "description": "the ID of the autoscale vm group", - "length": 255, - "name": "id", - "related": "enableAutoScaleVmGroup,listAutoScaleVmGroups", - "required": false, - "type": "uuid" - }, - { - "description": "the availability zone ID", + "description": "the ID of the profile", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "vmprofileid", + "related": "createAutoScaleVmProfile,listAutoScaleVmProfiles,updateAutoScaleVmProfile", "required": false, "type": "uuid" }, @@ -70662,76 +70851,100 @@ "type": "integer" }, { - "description": "the ID of the loadbalancer", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "lbruleid", - "related": "listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule", + "name": "domainid", + "related": "createDomain,listDomains,listDomains,moveDomain", "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 policy", "length": 255, - "name": "listall", + "name": "policyid", + "related": "listAutoScalePolicies", + "required": false, + "type": "uuid" + }, + { + "description": "the ID of the loadbalancer", + "length": 255, + "name": "lbruleid", + "related": "listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule", + "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" } ], "related": "enableAutoScaleVmGroup", "response": [ - {}, - { - "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 domain name of the vm group", - "name": "domain", + "description": "the private port", + "name": "privateport", "type": "string" }, { - "description": "path of the domain to which the vm group belongs", - "name": "domainpath", + "description": "the public port", + "name": "publicport", "type": "string" }, - {}, { - "description": "the private port", - "name": "privateport", + "description": "the load balancer rule ID", + "name": "lbruleid", "type": "string" }, { - "description": "the public ip address id", - "name": "publicipid", + "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 date when this vm group was created", + "name": "created", + "type": "date" + }, + { + "description": "the project id of the vm group", + "name": "projectid", "type": "string" }, { - "description": "the autoscale vm group ID", - "name": "id", + "description": "path of the domain to which the vm group belongs", + "name": "domainpath", "type": "string" }, { - "description": "the 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 domain ID of the vm group", - "name": "domainid", + "description": "the lb provider of the guest network the lb rule belongs to", + "name": "lbprovider", "type": "string" }, { @@ -70740,48 +70953,44 @@ "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 load balancer rule ID", - "name": "lbruleid", + "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", - "type": "list" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the name of the autoscale vm group ", + "name": "name", + "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 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 public ip address id", + "name": "publicipid", + "type": "string" }, + {}, { - "description": "the lb provider of the guest network the lb rule belongs to", - "name": "lbprovider", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the project name of the vm group", - "name": "project", + "description": "the current state of the AutoScale Vm Group", + "name": "state", "type": "string" }, { - "description": "the public port", - "name": "publicport", + "description": "the id of the guest network the lb rule belongs to", + "name": "associatednetworkid", "type": "string" }, { @@ -70790,28 +70999,24 @@ "type": "string" }, { - "description": "the name of the guest network the lb rule belongs to", - "name": "associatednetworkname", + "description": "the domain name of the vm group", + "name": "domain", "type": "string" }, { - "description": "the number of available virtual machines (in Running, Starting, Stopping or Migrating state) in the vmgroup", - "name": "availablevirtualmachinecount", + "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 public ip address", - "name": "publicip", + "description": "the domain ID of the vm group", + "name": "domainid", "type": "string" }, + {}, { - "description": "is group for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the current state of the AutoScale Vm Group", - "name": "state", + "description": "the name of the guest network the lb rule belongs to", + "name": "associatednetworkname", "type": "string" }, { @@ -70820,19 +71025,19 @@ "type": "int" }, { - "description": "the autoscale profile that contains information about the vms in the vm group.", - "name": "vmprofileid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the project id of the vm group", - "name": "projectid", + "description": "the autoscale vm group ID", + "name": "id", "type": "string" }, { - "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" } ] }, @@ -70842,18 +71047,19 @@ "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 ID of the Pod", "length": 255, - "name": "startip", - "required": false, - "type": "string" + "name": "id", + "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", + "required": true, + "type": "uuid" }, { "description": "the ending IP address for the Pod", @@ -70863,26 +71069,25 @@ "type": "string" }, { - "description": "Allocation state of this cluster for allocation of new resources", + "description": "the starting IP address for the Pod", "length": 255, - "name": "allocationstate", + "name": "startip", "required": false, "type": "string" }, { - "description": "the gateway for the Pod", + "description": "the name of the Pod", "length": 255, - "name": "gateway", + "name": "name", "required": false, "type": "string" }, { - "description": "the ID of the Pod", + "description": "the gateway for the Pod", "length": 255, - "name": "id", - "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", - "required": true, - "type": "uuid" + "name": "gateway", + "required": false, + "type": "string" }, { "description": "the netmask of the Pod", @@ -70895,14 +71100,14 @@ "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 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", - "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 netmask of the Pod", @@ -70910,21 +71115,9 @@ "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 Pod", - "name": "zonename", - "type": "string" - }, - {}, - {}, - { - "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 allocation state of the Pod", @@ -70935,34 +71128,19 @@ "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", - "type": "long" - }, { "description": "The tag for the capacity type", "name": "tag", "type": "string" }, { - "description": "the Pod ID", - "name": "podid", + "description": "the percentage of capacity currently in use", + "name": "percentused", "type": "string" }, { - "description": "the percentage of capacity currently in use", - "name": "percentused", + "description": "the Cluster ID", + "name": "clusterid", "type": "string" }, { @@ -70975,6 +71153,11 @@ "name": "zoneid", "type": "string" }, + { + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" + }, { "description": "the Cluster name", "name": "clustername", @@ -70986,18 +71169,28 @@ "type": "string" }, { - "description": "the Zone name", - "name": "zonename", + "description": "the Pod name", + "name": "podname", "type": "string" }, { - "description": "the Pod name", - "name": "podname", + "description": "the capacity type", + "name": "type", + "type": "short" + }, + { + "description": "the Pod ID", + "name": "podid", "type": "string" }, { - "description": "the Cluster ID", - "name": "clusterid", + "description": "the total capacity available", + "name": "capacitytotal", + "type": "long" + }, + { + "description": "the Zone name", + "name": "zonename", "type": "string" } ], @@ -71008,13 +71201,28 @@ "name": "zonestorageaccessgroups", "type": "string" }, + { + "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 ID of the Pod", + "name": "id", + "type": "string" + }, { "description": "the IP ranges for the Pod", "name": "ipranges", "response": [ { - "description": "the gateway for the range", - "name": "gateway", + "description": "the CIDR for the range", + "name": "cidr", "type": "string" }, { @@ -71023,8 +71231,8 @@ "type": "string" }, { - "description": "the CIDR for the range", - "name": "cidr", + "description": "the ending IP for the range", + "name": "endip", "type": "string" }, { @@ -71033,57 +71241,54 @@ "type": "string" }, { - "description": "indicates if range is dedicated for CPVM and SSVM", - "name": "forsystemvms", + "description": "the gateway for the range", + "name": "gateway", "type": "string" }, { - "description": "the ending IP for the range", - "name": "endip", + "description": "indicates if range is dedicated for CPVM and SSVM", + "name": "forsystemvms", "type": "string" } ], "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 UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the name of the Pod", - "name": "name", + "description": "the Zone name of the Pod", + "name": "zonename", "type": "string" }, { - "description": "the Zone ID of the Pod", - "name": "zoneid", + "description": "comma-separated list of storage access groups for the pod", + "name": "storageaccessgroups", "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 name of the Pod", + "name": "name", "type": "string" }, { - "description": "the starting IP for the Pod. This parameter is deprecated, please use 'startip' from ipranges parameter.", - "name": "startip", + "description": "indicates Vlan ID for the range. This parameter is deprecated, please use 'vlanid' from ipranges parameter.", + "name": "vlanid", "type": "list" }, { - "description": "indicates if range is dedicated for CPVM and SSVM. This parameter is deprecated, please use 'forsystemvms' from ipranges parameter.", - "name": "forsystemvms", - "type": "list" + "description": "the Zone ID of the Pod", + "name": "zoneid", + "type": "string" } ] }, @@ -71092,14 +71297,6 @@ "isasync": true, "name": "attachIso", "params": [ - { - "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", - "required": true, - "type": "uuid" - }, { "description": "If true, ejects existing ISO before attaching on VMware. Default: false", "length": 255, @@ -71108,60 +71305,33 @@ "since": "4.15.1", "type": "boolean" }, + { + "description": "the ID of the virtual machine", + "length": 255, + "name": "virtualmachineid", + "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,createVMFromBackup,createVMFromBackup,assignVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "required": true, + "type": "uuid" + }, { "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", + "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": "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,createVMFromBackup,createVMFromBackup,assignVirtualMachine,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "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", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { @@ -71170,214 +71340,530 @@ "type": "date" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", - "type": "string" - }, - { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", - "type": "string" + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "the 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 egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the 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": "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 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": "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 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 key name", + "name": "key", + "type": "string" + } + ], + "type": "set" + } + ], + "type": "set" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the 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": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "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": "the domain associated with the tag", + "name": "domain", + "type": "string" + } + ], + "type": "set" + }, + { + "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": "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 list of resource tags associated with the rule", + "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": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "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 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" + } + ], + "type": "set" + }, + { + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "the name of the security group", + "name": "name", + "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 ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "the description of the security group", + "name": "description", + "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 ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, + {}, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" - }, - { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", "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 ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "the project name of the vm", - "name": "project", - "type": "string" + "description": "the maximum number of display heads", + "name": "maxheads", + "type": "long" }, { - "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": "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": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", + "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 VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "type": "string" + "description": "the count of GPUs on the virtual machine", + "name": "gpucount", + "type": "integer" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "the maximum Y resolution", - "name": "maxresolutiony", - "type": "long" - }, - { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "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", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", + "description": "the name of 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", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "the format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "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": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "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": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" }, - {}, { "description": "the list of nics associated with vm", "name": "nic", "response": [ { - "description": "the type of the nic", - "name": "type", + "description": "the ID of the nic", + "name": "id", "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": "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 ID of the corresponding network", - "name": "networkid", + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "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": "Type of adapter if available", + "name": "adaptertype", "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": "Type of adapter if available", - "name": "adaptertype", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { @@ -71386,18 +71872,13 @@ "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 isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { @@ -71406,14 +71887,9 @@ "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 isolation uri of the nic", + "name": "isolationuri", + "type": "string" }, { "description": "the IPv6 address of network", @@ -71421,14 +71897,14 @@ "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" }, { "description": "the cidr of IPv6 network", @@ -71436,277 +71912,291 @@ "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", "type": "integer" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the traffic type of the nic", + "name": "traffictype", "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 vpc to which the nic belongs", - "name": "vpcid", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the gateway of the nic", + "name": "gateway", "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": "isdefault", + "type": "boolean" + }, { "description": "Id of the vm to which the nic belongs", "name": "virtualmachineid", "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 traffic type of the nic", - "name": "traffictype", - "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", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" } ], "type": "set" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" - }, - { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", - "type": "string" - }, - { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", - "type": "string" - }, - { - "description": "the count of GPUs on the virtual machine", - "name": "gpucount", - "type": "integer" - }, - { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" - }, - { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "User VM type", - "name": "vmtype", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", "type": "long" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", + "description": "the list of resource tags associated", + "name": "tags", "response": [ { - "description": "the domain ID of the affinity group", + "description": "the ID of the domain associated with the tag", "name": "domainid", "type": "string" }, { - "description": "the account owning the affinity group", - "name": "account", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", + "description": "the account associated with the tag", + "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": "customer associated with the tag", + "name": "customer", + "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the ID of the affinity group", - "name": "id", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" } ], "type": "set" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", - "type": "string" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, - {}, { - "description": "the video RAM size in MB", - "name": "videoram", + "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 list of resource tags associated", - "name": "tags", + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" + }, + { + "description": "CPU arch of the VM", + "name": "arch", + "type": "string" + }, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" + }, + { + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" + }, + { + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", "response": [ { - "description": "tag key name", - "name": "key", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" }, { - "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 type of the affinity group", + "name": "type", "type": "string" }, { - "description": "tag value", - "name": "value", - "type": "string" + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "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": "id of the resource", - "name": "resourceid", + "description": "the project name of the affinity group", + "name": "project", "type": "string" } ], "type": "set" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" + }, + { + "description": "the ID of the host for the virtual machine", + "name": "hostid", + "type": "string" }, { "description": "the pool type of the virtual machine", @@ -71714,68 +72204,70 @@ "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "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": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, + {}, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", + "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 vgpu profile to which service offering is linked", - "name": "vgpuprofileid", + "description": "the VM's primary IP address", + "name": "ipaddress", "type": "string" }, { - "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 maximum X resolution", - "name": "maxresolutionx", - "type": "long" + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", "type": "string" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { @@ -71784,470 +72276,178 @@ "type": "long" }, { - "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": "CPU arch of the VM", - "name": "arch", - "type": "string" + "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": "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": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", - "type": "string" + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "Instance lease expiry date", - "name": "leaseexpirydate", - "type": "date" + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", + "description": "the maximum Y resolution", + "name": "maxresolutiony", "type": "long" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", + "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": "the name of the domain in which the virtual machine exists", - "name": "domain", + "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", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the project id of the vm", + "name": "projectid", + "type": "string" + }, + { + "description": "VNF details", + "name": "vnfdetails", + "type": "map" + }, + { + "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 number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the account owning the security group", - "name": "account", - "type": "string" - }, - { - "description": "the project name of the group", - "name": "project", - "type": "string" - }, - { - "description": "the name of the security group", - "name": "name", - "type": "string" - }, - { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" - }, - { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the ID of the security group", - "name": "id", - "type": "string" - }, - { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", - "response": [ - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "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": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "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 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" - } - ], - "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", - "type": "integer" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "security group name", - "name": "securitygroupname", - "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", - "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 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 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 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" - }, - { - "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 project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the 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" - } - ], - "type": "set" + "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 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 user's name who deployed the virtual machine", + "name": "username", + "type": "string" + }, + { + "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": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, { "description": "true if vm has delete protection.", "name": "deleteprotection", "type": "boolean" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", + "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 updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the maximum X resolution", + "name": "maxresolutionx", "type": "long" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "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 memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "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 speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "User VM type", + "name": "vmtype", "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "Instance lease duration in days", + "name": "leaseduration", "type": "integer" }, { @@ -72256,23 +72456,28 @@ "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "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", + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", + "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": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" } ] @@ -72285,38 +72490,40 @@ "related": "", "response": [ { - "description": "Hostname or ip address of the ldap server eg: my.ldap.com", - "name": "hostname", + "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" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "Specify the distinguished name of a user with the search permission on the directory", - "name": "binddn", + "description": "Check Use SSL if the external LDAP server is configured for LDAP over SSL", + "name": "ssl", "type": "string" }, { - "description": "Specify the LDAP port if required, default is 389", - "name": "port", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "You specify a query filter here, which narrows down the users, who can be part of this domain", - "name": "queryfilter", + "description": "Hostname or ip address of the ldap server eg: my.ldap.com", + "name": "hostname", "type": "string" }, { - "description": "DN password", - "name": "bindpass", + "description": "You specify a query filter here, which narrows down the users, who can be part of this domain", + "name": "queryfilter", "type": "string" }, + {}, { - "description": "Check Use SSL if the external LDAP server is configured for LDAP over SSL", - "name": "ssl", + "description": "Specify the LDAP port if required, default is 389", + "name": "port", "type": "string" }, { @@ -72324,13 +72531,11 @@ "name": "searchbase", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {} + "description": "DN password", + "name": "bindpass", + "type": "string" + } ], "since": "3.0.1" }, @@ -72340,30 +72545,30 @@ "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.", + "description": "User UUID, required for adding account from external provisioning system", "length": 255, - "name": "account", - "required": true, + "name": "userid", + "required": false, "type": "string" }, { - "description": "email", + "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": "email", + "name": "password", "required": true, "type": "string" }, { - "description": "lastname", + "description": "Unique username.", "length": 255, - "name": "lastname", + "name": "username", "required": true, "type": "string" }, { - "description": "Clear text password (Default hashed to SHA256SALT). If you wish to use any other hashing algorithm, you would need to write a custom authentication adapter See Docs section.", + "description": "email", "length": 255, - "name": "password", + "name": "email", "required": true, "type": "string" }, @@ -72376,132 +72581,132 @@ "type": "uuid" }, { - "description": "Unique username.", + "description": "lastname", "length": 255, - "name": "username", + "name": "lastname", "required": true, "type": "string" }, { - "description": "User UUID, required for adding account from external provisioning system", + "description": "firstname", "length": 255, - "name": "userid", - "required": false, + "name": "firstname", + "required": true, "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": "firstname", + "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", "length": 255, - "name": "firstname", - "required": true, + "name": "timezone", + "required": false, "type": "string" } ], "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": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the user state", - "name": "state", + "description": "the user firstname", + "name": "firstname", "type": "string" }, { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", + "description": "true if user has two factor authentication is mandated", + "name": "is2famandated", "type": "boolean" }, { - "description": "the account name of the user", - "name": "account", - "type": "string" + "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", + "name": "apikeyaccess", + "type": "apikeyaccess" }, { - "description": "the type of the role", - "name": "roletype", + "description": "the user state", + "name": "state", "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the name of the role", - "name": "rolename", + "description": "the secret key of the user", + "name": "secretkey", "type": "string" }, + {}, { - "description": "the user lastname", - "name": "lastname", + "description": "the domain name of the user", + "name": "domain", "type": "string" }, { - "description": "the user name", - "name": "username", + "description": "the account name of the user", + "name": "account", "type": "string" }, - {}, { - "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": "the domain name of the user", - "name": "domain", + "description": "the user email address", + "name": "email", "type": "string" }, - {}, { - "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", - "name": "apikeyaccess", - "type": "apikeyaccess" + "description": "true if user has two factor authentication enabled", + "name": "is2faenabled", + "type": "boolean" }, { - "description": "the user firstname", - "name": "firstname", + "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 account ID of the user", "name": "accountid", "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 user ID", - "name": "id", + "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 name", + "name": "username", + "type": "string" }, { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the user lastname", + "name": "lastname", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", @@ -72509,38 +72714,38 @@ "type": "string" }, { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", + "description": "the timezone user was created in", + "name": "timezone", "type": "string" }, { - "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": "true if user has two factor authentication enabled", - "name": "is2faenabled", - "type": "boolean" + "description": "the user ID", + "name": "id", + "type": "string" }, { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" + "description": "the ID of the role", + "name": "roleid", + "type": "string" }, { - "description": "the domain ID of the user", - "name": "domainid", + "description": "the api key of the user", + "name": "apikey", "type": "string" }, { - "description": "the user email address", - "name": "email", + "description": "the domain ID of the user", + "name": "domainid", "type": "string" }, { - "description": "the secret key of the user", - "name": "secretkey", + "description": "the name of the role", + "name": "rolename", "type": "string" } ] @@ -72550,20 +72755,6 @@ "isasync": false, "name": "addCustomAction", "params": [ - { - "description": "Whether the action is enabled or not. Default is disabled.", - "length": 255, - "name": "enabled", - "required": false, - "type": "boolean" - }, - { - "description": "Specifies the timeout in seconds to wait for the action to complete before failing. Default value is 5 seconds", - "length": 255, - "name": "timeout", - "required": false, - "type": "integer" - }, { "description": "Description of the action", "length": 255, @@ -72572,12 +72763,18 @@ "type": "string" }, { - "description": "The ID of the extension to associate the action with", + "description": "Name of the action", "length": 255, - "name": "extensionid", - "related": "listExtensions,deleteExtension,updateExtension,registerExtension,unregisterExtension", + "name": "name", "required": true, - "type": "uuid" + "type": "string" + }, + { + "description": "Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].vendor=xxx&&details[0].version=2.0", + "length": 255, + "name": "details", + "required": false, + "type": "map" }, { "description": "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}}", @@ -72587,25 +72784,33 @@ "type": "string" }, { - "description": "Name of the action", + "description": "Specifies the timeout in seconds to wait for the action to complete before failing. Default value is 5 seconds", "length": 255, - "name": "name", - "required": true, - "type": "string" + "name": "timeout", + "required": false, + "type": "integer" }, { - "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": "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": "Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].vendor=xxx&&details[0].version=2.0", + "description": "Whether the action is enabled or not. Default is disabled.", "length": 255, - "name": "details", + "name": "enabled", "required": false, - "type": "map" + "type": "boolean" + }, + { + "description": "The ID of the extension to associate the action with", + "length": 255, + "name": "extensionid", + "related": "listExtensions,deleteExtension,updateExtension,registerExtension,unregisterExtension", + "required": true, + "type": "uuid" }, { "description": "List of role types allowed for the action", @@ -72615,16 +72820,16 @@ "type": "list" }, { - "description": "Parameters mapping for the action using keys - name, type, required. 'name' is mandatory. If 'type' is not specified then STRING will be used. If 'required' is not specified then false will be used. Example: parameters[0].name=xxx¶meters[0].type=BOOLEAN¶meters[0].required=true", + "description": "Resource type for which the action is available", "length": 255, - "name": "parameters", + "name": "resourcetype", "required": false, - "type": "map" + "type": "string" }, { - "description": "Resource type for which the action is available", + "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": "resourcetype", + "name": "errormessage", "required": false, "type": "string" } @@ -72632,97 +72837,70 @@ "related": "listCustomActions", "response": [ { - "description": "List of the parameters for the action", - "name": "parameters", - "response": [ - { - "description": "Whether the parameter is required or not", - "name": "required", - "type": "boolean" - }, - { - "description": "Validation format for value of the parameter. Available for specific types", - "name": "validationformat", - "type": "string" - }, - { - "description": "Comma-separated list of options for value of the parameter", - "name": "valueoptions", - "type": "list" - }, - { - "description": "Name of the parameter", - "name": "name", - "type": "string" - }, - { - "description": "Type of the parameter", - "name": "type", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "Name of the custom action", - "name": "name", + "description": "ID of the custom action", + "name": "id", "type": "string" }, { - "description": "Name of the extension that this custom action belongs to", - "name": "extensionname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Details of the custom action", - "name": "details", - "type": "map" + "description": "Description of the custom action", + "name": "description", + "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": "List of role types allowed for the custom action", "name": "allowedroletypes", "type": "list" }, - { - "description": "Specifies the timeout in seconds to wait for the action to complete before failing", - "name": "timeout", - "type": "integer" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, { - "description": "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": "Creation timestamp of the custom action", - "name": "created", - "type": "date" + "description": "ID of the extension that this custom action belongs to", + "name": "extensionid", + "type": "string" }, { - "description": "Description of the custom action", - "name": "description", + "description": "Resource type for which the action is available", + "name": "resourcetype", "type": "string" }, + { + "description": "Whether the custom action is enabled or not", + "name": "enabled", + "type": "boolean" + }, {}, { - "description": "ID of the custom action", - "name": "id", + "description": "Message that will be used on successful execution of the action", + "name": "successmessage", "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": "Name of the custom action", + "name": "name", "type": "string" }, { @@ -72731,14 +72909,41 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "Specifies the timeout in seconds to wait for the action to complete before failing", + "name": "timeout", + "type": "integer" }, { - "description": "Resource type for which the action is available", - "name": "resourcetype", - "type": "string" + "description": "List of the parameters for the action", + "name": "parameters", + "response": [ + { + "description": "Comma-separated list of options for value of the parameter", + "name": "valueoptions", + "type": "list" + }, + { + "description": "Type of the parameter", + "name": "type", + "type": "string" + }, + { + "description": "Validation format for value of the parameter. Available for specific types", + "name": "validationformat", + "type": "string" + }, + { + "description": "Whether the parameter is required or not", + "name": "required", + "type": "boolean" + }, + { + "description": "Name of the parameter", + "name": "name", + "type": "string" + } + ], + "type": "list" } ], "since": "4.21.0" @@ -72748,6 +72953,14 @@ "isasync": true, "name": "createVpnGateway", "params": [ + { + "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, @@ -72757,14 +72970,6 @@ "since": "4.21.0", "type": "uuid" }, - { - "description": "id of the vpc", - "length": 255, - "name": "vpcid", - "related": "listVPCs,createVPC,listVPCs,updateVPC", - "required": true, - "type": "uuid" - }, { "description": "an optional field, whether to the display the vpn to the end user or not", "length": 255, @@ -72781,15 +72986,14 @@ "name": "jobid", "type": "string" }, - {}, { - "description": "the domain name of the owner", - "name": "domain", + "description": "the domain id of the owner", + "name": "domainid", "type": "string" }, { - "description": "the domain path of the owner", - "name": "domainpath", + "description": "the domain name of the owner", + "name": "domain", "type": "string" }, { @@ -72798,9 +73002,19 @@ "type": "string" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "the vpn gateway ID", + "name": "id", + "type": "string" + }, + { + "description": "the domain path of the owner", + "name": "domainpath", + "type": "string" + }, + { + "description": "the owner", + "name": "account", + "type": "string" }, { "description": "the project name", @@ -72808,45 +73022,36 @@ "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": "the date and time the host was removed", + "name": "removed", + "type": "date" }, { "description": "is vpn gateway for display to the regular user", "name": "fordisplay", "type": "boolean" }, - { - "description": "the vpn gateway ID", - "name": "id", - "type": "string" - }, + {}, { "description": "the vpc id of this gateway", "name": "vpcid", "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 vpc name of this gateway", "name": "vpcname", "type": "string" - }, - { - "description": "the owner", - "name": "account", - "type": "string" - }, - {}, - { - "description": "the domain id of the owner", - "name": "domainid", - "type": "string" } ] }, @@ -72855,6 +73060,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,13 +73088,6 @@ "name": "resourcetype", "required": true, "type": "string" - }, - { - "description": "resource id to create the details for", - "length": 255, - "name": "resourceid", - "required": true, - "type": "string" } ], "response": [ @@ -72891,23 +73096,23 @@ "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" - }, - {} + } ] }, { @@ -72916,26 +73121,27 @@ "name": "listVpnUsers", "params": [ { - "description": "", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "pagesize", + "name": "domainid", + "related": "createDomain,listDomains,listDomains,moveDomain", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "", + "description": "The uuid of the Vpn user", "length": 255, - "name": "page", + "name": "id", + "related": "addVpnUser,listVpnUsers", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "list only resources belonging to the domain specified", + "description": "List by keyword", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains,moveDomain", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { "description": "list resources by account. Must be used with the domainId parameter.", @@ -72945,81 +73151,90 @@ "type": "string" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "isrecursive", + "name": "listall", "required": false, "type": "boolean" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "", "length": 255, - "name": "projectid", - "related": "activateProject,createProject", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "List by keyword", + "description": "the username of the vpn user.", "length": 255, - "name": "keyword", + "name": "username", "required": false, "type": "string" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "listall", + "name": "isrecursive", "required": false, "type": "boolean" }, { - "description": "the username of the vpn user.", + "description": "", "length": 255, - "name": "username", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "The uuid of the Vpn user", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "id", - "related": "addVpnUser,listVpnUsers", + "name": "projectid", + "related": "activateProject,createProject", "required": false, "type": "uuid" } ], "related": "addVpnUser", "response": [ + { + "description": "the domain name of the account of the remote access vpn", + "name": "domain", + "type": "string" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "the vpn userID", + "name": "id", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the project id of the vpn", "name": "projectid", "type": "string" }, - {}, { - "description": "the username of the vpn user", - "name": "username", + "description": "the account of the remote access vpn", + "name": "account", "type": "string" }, + {}, { - "description": "the domain name of the account of the remote access vpn", - "name": "domain", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": "the vpn userID", - "name": "id", + "description": "the domain id of the account of the remote access vpn", + "name": "domainid", "type": "string" }, { @@ -73028,8 +73243,8 @@ "type": "string" }, { - "description": "the domain id of the account of the remote access vpn", - "name": "domainid", + "description": "the username of the vpn user", + "name": "username", "type": "string" }, { @@ -73037,17 +73252,7 @@ "name": "state", "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", - "type": "string" - } + {} ] }, { @@ -73065,21 +73270,21 @@ } ], "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" }, { @@ -73123,45 +73328,45 @@ "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": "createDomain,listDomains,listDomains,moveDomain", + "name": "projectid", + "related": "activateProject,createProject", "required": false, "type": "uuid" }, { - "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": "activateProject,createProject", + "name": "domainid", + "related": "createDomain,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": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } + {} ], "since": "4.18" }, @@ -73171,11 +73376,11 @@ "name": "addRegion", "params": [ { - "description": "Id of the Region", + "description": "Name of the region", "length": 255, - "name": "id", + "name": "name", "required": true, - "type": "integer" + "type": "string" }, { "description": "Region service endpoint", @@ -73185,22 +73390,26 @@ "type": "string" }, { - "description": "Name of the region", + "description": "Id of the Region", "length": 255, - "name": "name", + "name": "id", "required": true, - "type": "string" + "type": "integer" } ], "related": "updateRegion", "response": [ - {}, - {}, { - "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" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, + {}, { "description": "the end point of the region", "name": "endpoint", @@ -73211,11 +73420,7 @@ "name": "portableipserviceenabled", "type": "boolean" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, + {}, { "description": "the ID of the region", "name": "id", @@ -73227,9 +73432,9 @@ "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" } ] }, @@ -73238,6 +73443,13 @@ "isasync": false, "name": "generateUsageRecords", "params": [ + { + "description": "End date range for usage record query. Use yyyy-MM-dd as the date format, e.g. startDate=2009-06-03.", + "length": 255, + "name": "enddate", + "required": false, + "type": "date" + }, { "description": "List events for the specified domain.", "length": 255, @@ -73252,13 +73464,6 @@ "name": "startdate", "required": false, "type": "date" - }, - { - "description": "End date range for usage record query. Use yyyy-MM-dd as the date format, e.g. startDate=2009-06-03.", - "length": 255, - "name": "enddate", - "required": false, - "type": "date" } ], "response": [ @@ -73267,12 +73472,6 @@ "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", @@ -73283,6 +73482,12 @@ "name": "jobstatus", "type": "integer" }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + {}, {} ] }, @@ -73292,13 +73497,20 @@ "name": "updateRolePermission", "params": [ { - "description": "Role permission rule id", + "description": "Rule permission, can be: allow or deny", "length": 255, - "name": "ruleid", - "related": "", + "name": "permission", "required": false, "since": "4.11", - "type": "uuid" + "type": "string" + }, + { + "description": "The parent role permission uuid, use 0 to move this rule at the top of the list", + "length": 255, + "name": "ruleorder", + "related": "", + "required": false, + "type": "list" }, { "description": "ID of the role", @@ -73309,20 +73521,13 @@ "type": "uuid" }, { - "description": "Rule permission, can be: allow or deny", - "length": 255, - "name": "permission", - "required": false, - "since": "4.11", - "type": "string" - }, - { - "description": "The parent role permission uuid, use 0 to move this rule at the top of the list", + "description": "Role permission rule id", "length": 255, - "name": "ruleorder", + "name": "ruleid", "related": "", "required": false, - "type": "list" + "since": "4.11", + "type": "uuid" } ], "response": [ @@ -73331,23 +73536,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": "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.9.0" }, @@ -73357,18 +73562,18 @@ "name": "listAccounts", "params": [ { - "description": "list account by account name", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "name", + "name": "isrecursive", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "list accounts by account type. Valid account types are 1 (admin), 2 (domain-admin), and 0 (user).", + "description": "list account by account name", "length": 255, - "name": "accounttype", + "name": "name", "required": false, - "type": "integer" + "type": "string" }, { "description": "list only resources belonging to the domain specified", @@ -73379,11 +73584,26 @@ "type": "uuid" }, { - "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": "Tag for resource type to return usage", + "length": 255, + "name": "tag", + "required": false, + "since": "4.20.0", + "type": "string" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "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.", @@ -73400,19 +73620,11 @@ "type": "list" }, { - "description": "List accounts by the Api key access value", - "length": 255, - "name": "apikeyaccess", - "required": false, - "since": "4.20.1.0", - "type": "string" - }, - { - "description": "list accounts by state. Valid states are enabled, disabled, and locked.", + "description": "list accounts by account type. Valid account types are 1 (admin), 2 (domain-admin), and 0 (user).", "length": 255, - "name": "state", + "name": "accounttype", "required": false, - "type": "string" + "type": "integer" }, { "description": "", @@ -73422,11 +73634,12 @@ "type": "integer" }, { - "description": "flag to display the resource icon for accounts", + "description": "List accounts by the Api key access value", "length": 255, - "name": "showicon", + "name": "apikeyaccess", "required": false, - "type": "boolean" + "since": "4.20.1.0", + "type": "string" }, { "description": "list accounts by cleanuprequired attribute (values are true or false)", @@ -73436,19 +73649,11 @@ "type": "boolean" }, { - "description": "Tag for resource type to return usage", - "length": 255, - "name": "tag", - "required": false, - "since": "4.20.0", - "type": "string" - }, - { - "description": "", + "description": "flag to display the resource icon for accounts", "length": 255, - "name": "pagesize", + "name": "showicon", "required": false, - "type": "integer" + "type": "boolean" }, { "description": "list account by account ID", @@ -73459,9 +73664,9 @@ "type": "uuid" }, { - "description": "List by keyword", + "description": "list accounts by state. Valid states are enabled, disabled, and locked.", "length": 255, - "name": "keyword", + "name": "state", "required": false, "type": "string" } @@ -73469,168 +73674,97 @@ "related": "disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts", "response": [ { - "description": "true if the account requires cleanup", - "name": "iscleanuprequired", - "type": "boolean" - }, - { - "description": "the total number of cpu cores the account can own", - "name": "cpulimit", - "type": "string" - }, - { - "description": "the total volume which can be used by this account", - "name": "volumelimit", - "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 primary storage space (in GiB) available to be used for this account", - "name": "primarystorageavailable", - "type": "string" - }, - { - "description": "the total secondary storage space (in GiB) owned by account", - "name": "secondarystoragetotal", - "type": "float" - }, - { - "description": "The tagged resource limit and count for the account", - "name": "taggedresources", - "type": "list" - }, - { - "description": "the total number of buckets available to this account", - "name": "bucketavailable", - "type": "string" - }, - { - "description": "the total backup storage space (in GiB) owned by the account", - "name": "backupstoragetotal", - "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", - "type": "string" - }, - { - "description": "the network domain", - "name": "networkdomain", - "type": "string" - }, - { - "description": "the total primary storage space (in GiB) owned by account", - "name": "primarystoragetotal", - "type": "long" - }, - { - "description": "the total 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", - "type": "string" - }, - { - "description": "the total number of gpus owned by account", - "name": "gputotal", - "type": "long" - }, - { - "description": "the total number of virtual machines running for this account", - "name": "vmrunning", - "type": "integer" - }, - { - "description": "the name of the role", - "name": "rolename", + "description": "path of the Domain the account belongs to", + "name": "domainpath", "type": "string" }, { - "description": "path of the Domain the account belongs to", - "name": "domainpath", + "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", + "name": "roletype", "type": "string" }, { "description": "the list of users associated with account", "name": "user", "response": [ + { + "description": "the ID of the role", + "name": "roleid", + "type": "string" + }, { "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", "name": "apikeyaccess", "type": "apikeyaccess" }, { - "description": "true if user has two factor authentication enabled", - "name": "is2faenabled", + "description": "true if user has two factor authentication is mandated", + "name": "is2famandated", "type": "boolean" }, { - "description": "the 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" }, { - "description": "the timezone user was created in", - "name": "timezone", + "description": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the user email address", + "name": "email", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the domain ID of the user", + "name": "domainid", + "type": "string" }, { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" + }, + { + "description": "true if user has two factor authentication enabled", + "name": "is2faenabled", + "type": "boolean" + }, + { + "description": "the user ID", + "name": "id", "type": "string" }, { - "description": "the name of the role", - "name": "rolename", + "description": "the user firstname", + "name": "firstname", "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": "the ID of the role", - "name": "roleid", + "description": "the account ID of the user", + "name": "accountid", "type": "string" }, { - "description": "the type of the role", - "name": "roletype", + "description": "the account name of the user", + "name": "account", "type": "string" }, { - "description": "the secret key of the user", - "name": "secretkey", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the domain name of the user", + "name": "domain", "type": "string" }, { @@ -73639,18 +73773,18 @@ "type": "string" }, { - "description": "the account ID of the user", - "name": "accountid", + "description": "the timezone user was created in", + "name": "timezone", "type": "string" }, { - "description": "the user ID", - "name": "id", + "description": "the user lastname", + "name": "lastname", "type": "string" }, { - "description": "the api key of the user", - "name": "apikey", + "description": "the name of the role", + "name": "rolename", "type": "string" }, { @@ -73663,93 +73797,102 @@ "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", + "description": "the secret key of the user", + "name": "secretkey", "type": "string" }, { - "description": "the account name of the user", - "name": "account", + "description": "the type of the role", + "name": "roletype", "type": "string" - }, - { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" } ], "type": "list" }, - {}, { - "description": "the name of the account", - "name": "name", + "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", + "type": "long" + }, + { + "description": "the date when this account was created", + "name": "created", + "type": "date" + }, + { + "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 total memory (in MB) owned by account", + "name": "memorytotal", + "type": "long" + }, + { + "description": "the total number of networks available to be created for this account", + "name": "networkavailable", "type": "string" }, { - "description": "the default zone of the account", - "name": "defaultzoneid", + "description": "name of the Domain the account belongs to", + "name": "domain", "type": "string" }, + { + "description": "the total number of virtual machines deployed by this account", + "name": "vmtotal", + "type": "long" + }, { "description": "the total volume available for this account", "name": "volumeavailable", "type": "string" }, { - "description": "the total number of backups available to this account", - "name": "backupavailable", + "description": "the name of the role", + "name": "rolename", "type": "string" }, { - "description": "the total number of public ip addresses this account can acquire", - "name": "iplimit", + "description": "the total number of virtual machines available for this account to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "the total number of public ip addresses available for this account to acquire", - "name": "ipavailable", + "description": "the total secondary storage space (in GiB) the account can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "id of the Domain the account belongs to", - "name": "domainid", - "type": "string" + "description": "the total number of snapshots stored by this account", + "name": "snapshottotal", + "type": "long" }, { - "description": "the total number of virtual machines that can be deployed by this account", - "name": "vmlimit", + "description": "the total number of buckets available to this account", + "name": "bucketavailable", "type": "string" }, { - "description": "the total number of templates available to be created by this account", - "name": "templateavailable", + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { @@ -73758,33 +73901,38 @@ "type": "string" }, { - "description": "name of the Domain the account belongs to", - "name": "domain", + "description": "the total number of public ip addresses available for this account to acquire", + "name": "ipavailable", "type": "string" }, { - "description": "the total primary storage space (in GiB) the account can own", - "name": "primarystoragelimit", + "description": "the total number of snapshots which can be stored by this account", + "name": "snapshotlimit", "type": "string" }, { - "description": "the id of the account", - "name": "id", + "description": "the total number of backups which can be stored by this account", + "name": "backuplimit", "type": "string" }, { - "description": "account type (admin, domain-admin, user)", - "name": "accounttype", - "type": "integer" + "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": "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 snapshots stored by this account", - "name": "snapshottotal", + "description": "the total object storage space (in GiB) owned by the account", + "name": "objectstoragetotal", + "type": "long" + }, + { + "description": "the total number of projects being administrated by this account", + "name": "projecttotal", "type": "long" }, { @@ -73793,58 +73941,84 @@ "type": "string" }, { - "description": "the total number of gpus the account can own", - "name": "gpulimit", + "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) the account can own", - "name": "secondarystoragelimit", + "description": "the total number of buckets which can be stored by this account", + "name": "bucketlimit", "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "the state of the account", + "name": "state", "type": "string" }, { - "description": "the date when this account was created", - "name": "created", - "type": "date" + "description": "account type (admin, domain-admin, user)", + "name": "accounttype", + "type": "integer" }, { - "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) owned by the account", + "name": "backupstoragetotal", + "type": "long" }, { - "description": "the total number of buckets which can be stored by this account", - "name": "bucketlimit", + "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 network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "the id of the account", + "name": "id", "type": "string" }, { - "description": "the total backup storage space (in GiB) the account can own", - "name": "backupstoragelimit", + "description": "the total object storage space (in GiB) available to the account", + "name": "objectstorageavailable", "type": "string" }, + {}, { - "description": "the total number of virtual machines deployed by this account", - "name": "vmtotal", + "description": "the total number of backups stored by this account", + "name": "backuptotal", "type": "long" }, { - "description": "the total number of cpu cores owned by account", - "name": "cputotal", - "type": "long" + "description": "the total number of templates available to be created by this account", + "name": "templateavailable", + "type": "string" }, { - "description": "the state of the account", - "name": "state", + "description": "the total memory (in MB) the account can own", + "name": "memorylimit", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", + "description": "the total number of projects the account can own", + "name": "projectlimit", + "type": "string" + }, + { + "description": "the list of acl groups that account belongs to", + "name": "groups", + "type": "list" + }, + { + "description": "the total number of templates which have been created by this account", + "name": "templatetotal", "type": "long" }, { @@ -73853,88 +74027,119 @@ "type": "long" }, { - "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", - "name": "roletype", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { - "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 the account can own", - "name": "projectlimit", + "description": "the total number of projects available for administration by this account", + "name": "projectavailable", "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 projects available for administration by this account", - "name": "projectavailable", - "type": "string" + "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": "the total backup storage space (in GiB) the account can own", + "name": "backupstoragelimit", + "type": "string" }, { - "description": "the total memory (in MB) available to be created for this account", - "name": "memoryavailable", + "description": "the total number of vpcs the account can own", + "name": "vpclimit", "type": "string" }, { - "description": "the total number of templates which can be created by this account", - "name": "templatelimit", + "description": "the total primary storage space (in GiB) the account can own", + "name": "primarystoragelimit", "type": "string" }, { - "description": "the total object storage space (in GiB) available to the account", - "name": "objectstorageavailable", - "type": "string" + "description": "the total secondary storage space (in GiB) owned by account", + "name": "secondarystoragetotal", + "type": "float" }, + {}, { - "description": "the total memory (in MB) the account can own", - "name": "memorylimit", + "description": "the total volume which can be used by this account", + "name": "volumelimit", "type": "string" }, { - "description": "the list of acl groups that account belongs to", - "name": "groups", - "type": "list" + "description": "the total number of cpu cores owned by account", + "name": "cputotal", + "type": "long" }, { - "description": "the total memory (in MB) owned by account", - "name": "memorytotal", + "description": "the total number of gpus the account can own", + "name": "gpulimit", + "type": "string" + }, + { + "description": "the total primary storage space (in GiB) owned by account", + "name": "primarystoragetotal", "type": "long" }, + { + "description": "details for the account", + "name": "accountdetails", + "type": "map" + }, + { + "description": "the total memory (in MB) available to be created for this account", + "name": "memoryavailable", + "type": "string" + }, { "description": "the total object storage space (in GiB) the account can own", "name": "objectstoragelimit", "type": "string" }, { - "description": "the total object storage space (in GiB) owned by the account", - "name": "objectstoragetotal", - "type": "long" + "description": "the total number of cpu cores available to be created for this account", + "name": "cpuavailable", + "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": "the total number of networks available to be created for this account", - "name": "networkavailable", + "description": "the total number of gpus available to be created for this account", + "name": "gpuavailable", "type": "string" }, { - "description": "the total number of snapshots which can be stored by this account", - "name": "snapshotlimit", + "description": "The tagged resource limit and count for the account", + "name": "taggedresources", + "type": "list" + }, + { + "description": "the total number of templates which can be created by this account", + "name": "templatelimit", + "type": "string" + }, + { + "description": "id of the Domain the account belongs to", + "name": "domainid", "type": "string" }, { @@ -73943,49 +74148,49 @@ "type": "long" }, { - "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", - "name": "apikeyaccess", - "type": "apikeyaccess" + "description": "the total number of virtual machines stopped for this account", + "name": "vmstopped", + "type": "integer" }, { - "description": "the total number of vpcs the account can own", - "name": "vpclimit", + "description": "the default zone of the account", + "name": "defaultzoneid", "type": "string" }, { - "description": "the total number of networks owned by account", - "name": "networktotal", - "type": "long" + "description": "the total number of cpu cores the account can own", + "name": "cpulimit", + "type": "string" }, { - "description": "details for the account", - "name": "accountdetails", - "type": "map" + "description": "the total number of public ip addresses allocated for this account", + "name": "iptotal", + "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the total number of gpus owned by account", + "name": "gputotal", + "type": "long" }, { - "description": "the total number of cpu cores available to be created for this account", - "name": "cpuavailable", + "description": "the name of the account", + "name": "name", "type": "string" }, { - "description": "the total number of templates which have been created by this account", - "name": "templatetotal", - "type": "long" + "description": "the total number of virtual machines that can be deployed by this account", + "name": "vmlimit", + "type": "string" }, { - "description": "the total backup storage space (in GiB) available to the account", - "name": "backupstorageavailable", + "description": "the total number of backups available to this account", + "name": "backupavailable", "type": "string" }, { - "description": "the total volume being used by this account", - "name": "volumetotal", - "type": "long" + "description": "the total number of public ip addresses this account can acquire", + "name": "iplimit", + "type": "string" } ] }, @@ -74006,188 +74211,183 @@ "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", + "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 version of scripts", + "name": "scriptsversion", "type": "string" }, { - "description": "the Zone ID for the router", - "name": "zoneid", + "description": "the host ID for the router", + "name": "hostid", "type": "string" }, - {}, { - "description": "CPU arch of the router", - "name": "arch", + "description": "the second DNS for the router", + "name": "dns2", "type": "string" }, { - "description": "the domain ID associated with the router", - "name": "domainid", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the Pod ID for the router", - "name": "podid", + "description": "the Pod name for the router", + "name": "podname", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the second IPv6 DNS for the router", + "name": "ip6dns2", "type": "string" }, { - "description": "path of the Domain the router belongs to", - "name": "domainpath", + "description": "the Zone ID for the router", + "name": "zoneid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the network domain for the router", + "name": "networkdomain", + "type": "string" }, { - "description": "the name of VPC the router belongs to", - "name": "vpcname", + "description": "the ID of the corresponding guest network", + "name": "guestnetworkid", "type": "string" }, { - "description": "the template name for the router", - "name": "templatename", + "description": "the template ID for the router", + "name": "templateid", "type": "string" }, {}, { - "description": "the name of the router", - "name": "name", + "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", + "description": "the name of the router", + "name": "name", "type": "string" }, { - "description": "the guest IP address for the router", - "name": "guestipaddress", + "description": "the name of VPC the router belongs to", + "name": "vpcname", "type": "string" }, { - "description": "role of the domain router", - "name": "role", + "description": "the state of redundant virtual router", + "name": "redundantstate", "type": "string" }, { - "description": "the first DNS for the router", - "name": "dns1", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "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 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 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 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 project id of the ipaddress", - "name": "projectid", + "description": "the hostname for the router", + "name": "hostname", "type": "string" }, { - "description": "the control state of the host for the router", - "name": "hostcontrolstate", + "description": "the version of the code / software in the router", + "name": "softwareversion", "type": "string" }, + {}, { - "description": "the guest netmask for the router", - "name": "guestnetmask", + "description": "the ID of the corresponding link local network", + "name": "linklocalnetworkid", "type": "string" }, { - "description": "the account associated with the router", - "name": "account", + "description": "the template name for the router", + "name": "templatename", "type": "string" }, { - "description": "the date and time the router was created", - "name": "created", - "type": "date" - }, - { - "description": "the version of template", - "name": "version", + "description": "the Pod ID for the router", + "name": "podid", "type": "string" }, { - "description": "the gateway for the router", - "name": "gateway", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "if this router is an redundant virtual router", - "name": "isredundantrouter", + "description": "true if any health checks had failed", + "name": "healthchecksfailed", "type": "boolean" }, { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", + "description": "the public MAC address for the router", + "name": "publicmacaddress", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the link local MAC address for the router", + "name": "linklocalmacaddress", "type": "string" }, { - "description": "the Zone name for the router", - "name": "zonename", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", + "description": "the account associated with the router", + "name": "account", "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", - "name": "success", - "type": "boolean" - }, - { - "description": "the name of the health check on the router", - "name": "checkname", - "type": "string" - }, - { - "description": "the date this VPC was created", - "name": "lastupdated", - "type": "date" - }, - { - "description": "detailed response generated on running health check", - "name": "details", - "type": "string" - } - ], - "type": "list" + "description": "the link local IP address for the router", + "name": "linklocalip", + "type": "string" }, { "description": "the ID of the corresponding public network", @@ -74195,23 +74395,13 @@ "type": "string" }, { - "description": "the project name of the address", - "name": "project", - "type": "string" - }, - { - "description": "the domain associated with the router", - "name": "domain", + "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", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { @@ -74219,54 +74409,34 @@ "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", - "type": "string" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "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": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" }, { "description": "the gateway of the nic", @@ -74274,20 +74444,10 @@ "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", + "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 Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, { "description": "the type of the nic", "name": "type", @@ -74299,23 +74459,33 @@ "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "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 isolation uri of the nic", - "name": "isolationuri", + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { @@ -74324,18 +74494,18 @@ "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": "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 ip address of the nic", - "name": "ipaddress", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { @@ -74344,13 +74514,23 @@ "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "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 broadcast uri of the nic", - "name": "broadcasturi", + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { @@ -74359,31 +74539,36 @@ "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "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": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" } ], "type": "set" }, { - "description": "the version of the code / software in the router", - "name": "softwareversion", - "type": "string" - }, - { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", + "description": "the control state of the host for the router", + "name": "hostcontrolstate", "type": "string" }, { @@ -74392,38 +74577,38 @@ "type": "string" }, { - "description": "the version of scripts", - "name": "scriptsversion", + "description": "the domain associated with the router", + "name": "domain", "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" }, { - "description": "VPC the router belongs to", - "name": "vpcid", + "description": "the gateway for the router", + "name": "gateway", "type": "string" }, { - "description": "the network domain for the router", - "name": "networkdomain", + "description": "path of the Domain the router belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the public netmask for the router", - "name": "publicnetmask", - "type": "string" + "description": "if this router is an redundant virtual router", + "name": "isredundantrouter", + "type": "boolean" }, { - "description": "the host ID for the router", - "name": "hostid", + "description": "the public netmask for the router", + "name": "publicnetmask", "type": "string" }, { - "description": "the link local IP address for the router", - "name": "linklocalip", + "description": "the guest IP address for the router", + "name": "guestipaddress", "type": "string" }, { @@ -74432,28 +74617,38 @@ "type": "boolean" }, { - "description": "the public MAC address for the router", - "name": "publicmacaddress", + "description": "the guest netmask for the router", + "name": "guestnetmask", "type": "string" }, { - "description": "the id of the router", - "name": "id", + "description": "VPC the router belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the Pod name for the router", - "name": "podname", + "description": "role of the domain router", + "name": "role", "type": "string" }, { - "description": "the ID of the corresponding guest network", - "name": "guestnetworkid", + "description": "the link local netmask for the router", + "name": "linklocalnetmask", "type": "string" }, { - "description": "the state of redundant virtual router", - "name": "redundantstate", + "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 Zone name for the router", + "name": "zonename", "type": "string" }, { @@ -74462,18 +74657,33 @@ "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the id of the router", + "name": "id", "type": "string" }, { - "description": "the name of the corresponding guest network", - "name": "guestnetworkname", + "description": "the version of template", + "name": "version", "type": "string" }, { - "description": "the template ID for the router", - "name": "templateid", + "description": "the project id of the ipaddress", + "name": "projectid", + "type": "string" + }, + { + "description": "CPU arch of the router", + "name": "arch", + "type": "string" + }, + { + "description": "the state of the router", + "name": "state", + "type": "state" + }, + { + "description": "the domain ID associated with the router", + "name": "domainid", "type": "string" } ] @@ -74484,11 +74694,19 @@ "name": "listImageStores", "params": [ { - "description": "the image store protocol", + "description": "", "length": 255, - "name": "protocol", + "name": "page", "required": false, - "type": "string" + "type": "integer" + }, + { + "description": "the ID of the storage pool", + "length": 255, + "name": "id", + "related": "addSecondaryStorage,addSwift,listSwifts,addImageStore,listImageStores", + "required": false, + "type": "uuid" }, { "description": "the image store provider", @@ -74498,11 +74716,13 @@ "type": "string" }, { - "description": "", + "description": "read-only status of the image store", "length": 255, - "name": "page", + "name": "readonly", + "related": "addSecondaryStorage,addSwift,listSwifts,addImageStore,listImageStores", "required": false, - "type": "integer" + "since": "4.15.0", + "type": "boolean" }, { "description": "the name of the image store", @@ -74526,21 +74746,11 @@ "type": "integer" }, { - "description": "read-only status of the image store", - "length": 255, - "name": "readonly", - "related": "addSecondaryStorage,addSwift,listSwifts,addImageStore,listImageStores", - "required": false, - "since": "4.15.0", - "type": "boolean" - }, - { - "description": "the ID of the storage pool", + "description": "the image store protocol", "length": 255, - "name": "id", - "related": "addSecondaryStorage,addSwift,listSwifts,addImageStore,listImageStores", + "name": "protocol", "required": false, - "type": "uuid" + "type": "string" }, { "description": "the Zone ID for the image store", @@ -74559,24 +74769,23 @@ "type": "scopetype" }, { - "description": "the provider name of the image store", - "name": "providername", - "type": "string" + "description": "defines if store is read-only", + "name": "readonly", + "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the protocol of the image store", + "name": "protocol", + "type": "string" }, - {}, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the protocol of the image store", - "name": "protocol", + "description": "the provider name of the image store", + "name": "providername", "type": "string" }, { @@ -74585,14 +74794,9 @@ "type": "string" }, { - "description": "defines if store is read-only", - "name": "readonly", - "type": "boolean" - }, - { - "description": "the host's currently used disk size", - "name": "disksizeused", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the url of the image store", @@ -74600,14 +74804,21 @@ "type": "string" }, { - "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": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" + }, { - "description": "the name of the image store", - "name": "name", - "type": "string" + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" }, { "description": "the Zone name of the image store", @@ -74615,16 +74826,15 @@ "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" - }, - {} + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } ], "since": "4.2.0" }, @@ -74643,28 +74853,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": "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" - }, - {}, - {} + } ] }, { @@ -74684,24 +74894,14 @@ "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", - "type": "string" - }, - { - "description": "the operation result description", - "name": "description", + "description": "the out-of-band management interface address", + "name": "address", "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 operation result", @@ -74709,24 +74909,29 @@ "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 action (if issued)", + "name": "action", + "type": "string" }, + {}, { - "description": "the out-of-band management interface address", - "name": "address", + "description": "the out-of-band management interface username", + "name": "username", "type": "string" }, - {}, { "description": "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": "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" }, { @@ -74734,21 +74939,26 @@ "name": "driver", "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", + "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 UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the operation result description", + "name": "description", + "type": "string" } ], "since": "4.9.0" @@ -74774,34 +74984,109 @@ "name": "projectaccountname", "type": "string" }, + { + "description": "the total object storage space (in GiB) owned by the project", + "name": "objectstoragetotal", + "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) the project can own", - "name": "primarystoragelimit", + "description": "the total memory (in MB) the project can own", + "name": "memorylimit", "type": "string" }, { - "description": "the total number of virtual machines available for this project to acquire", - "name": "vmavailable", + "description": "the total number of cpu cores the project can own", + "name": "cpulimit", "type": "string" }, { - "description": "the state of the project", - "name": "state", + "description": "the domain id the project belongs to", + "name": "domainid", "type": "string" }, { - "description": "the domain name where the project belongs to", - "name": "domain", + "description": "the total number of templates which can be created by this project", + "name": "templatelimit", "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by project", - "name": "primarystoragetotal", + "description": "the date this project was created", + "name": "created", + "type": "date" + }, + { + "description": "the total number of buckets which can be stored by this project", + "name": "bucketlimit", + "type": "string" + }, + { + "description": "the total 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", + "type": "string" + }, + { + "description": "the total number of cpu cores owned by project", + "name": "cputotal", + "type": "long" + }, + { + "description": "the total number of buckets stored by this project", + "name": "buckettotal", + "type": "long" + }, + { + "description": "the total number of backups stored by this project", + "name": "backuptotal", + "type": "long" + }, + { + "description": "the displaytext of the project", + "name": "displaytext", + "type": "string" + }, + { + "description": "the total number of virtual machines stopped for this project", + "name": "vmstopped", + "type": "integer" + }, + { + "description": "the total number of vpcs available to be created for this project", + "name": "vpcavailable", + "type": "string" + }, + { + "description": "the total volume available for this project", + "name": "volumeavailable", + "type": "string" + }, + { + "description": "the total number of virtual machines running for this project", + "name": "vmrunning", + "type": "integer" + }, + { + "description": "the total memory (in MB) owned by project", + "name": "memorytotal", + "type": "long" + }, + { + "description": "the total number of gpus owned by project", + "name": "gputotal", + "type": "long" + }, + { + "description": "the total volume being used by this project", + "name": "volumetotal", "type": "long" }, { @@ -74809,23 +75094,45 @@ "name": "owner", "type": "list" }, + { + "description": "the total number of virtual machines that can be deployed by this project", + "name": "vmlimit", + "type": "string" + }, + { + "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", + "type": "string" + }, + { + "description": "the total number of public ip addresses available for this project to acquire", + "name": "ipavailable", + "type": "string" + }, + { + "description": "the domain name where the project belongs to", + "name": "domain", + "type": "string" + }, + {}, + { + "description": "the total number of templates which have been created by this project", + "name": "templatetotal", + "type": "long" + }, { "description": "the list of resource tags associated with vm", "name": "tags", "response": [ { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -74834,18 +75141,18 @@ "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": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -74854,96 +75161,46 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "tag key name", + "name": "key", "type": "string" - } - ], - "type": "list" - }, - { - "description": "the total number of cpu cores available to be created for this project", - "name": "cpuavailable", - "type": "string" - }, - { - "description": "the total secondary storage space (in GiB) 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": "tag value", + "name": "value", + "type": "string" + }, + { + "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 total number of gpus the project can own", + "name": "gpulimit", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the total backup storage space (in GiB) owned by the project", - "name": "backupstoragetotal", - "type": "long" - }, - { - "description": "the total object storage space (in GiB) owned by the project", - "name": "objectstoragetotal", + "description": "the total number of virtual machines deployed by this project", + "name": "vmtotal", "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 number of gpus available to be created for this project", + "name": "gpuavailable", "type": "string" }, { @@ -74952,48 +75209,48 @@ "type": "string" }, { - "description": "the total backup storage space (in GiB) the project can own", - "name": "backupstoragelimit", + "description": "the total secondary storage space (in GiB) the project can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "the total number of cpu cores owned by project", - "name": "cputotal", - "type": "long" + "description": "the total number of backups which can be stored by this project", + "name": "backuplimit", + "type": "string" }, { - "description": "the total number of gpus owned by project", - "name": "gputotal", - "type": "long" + "description": "The tagged resource limit and count for the project", + "name": "taggedresources", + "type": "list" }, { - "description": "the total primary storage space (in GiB) available to be used for this project", - "name": "primarystorageavailable", + "description": "the id of the project", + "name": "id", "type": "string" }, { - "description": "the date this project was created", - "name": "created", - "type": "date" + "description": "the total volume which can be used by this project", + "name": "volumelimit", + "type": "string" }, { - "description": "the total backup storage space (in GiB) available to the project", - "name": "backupstorageavailable", + "description": "the total primary storage space (in GiB) the project can own", + "name": "primarystoragelimit", "type": "string" }, { - "description": "the domain id the project belongs to", - "name": "domainid", - "type": "string" + "description": "the total backup storage space (in GiB) owned by the project", + "name": "backupstoragetotal", + "type": "long" }, { - "description": "the total memory (in MB) the project can own", - "name": "memorylimit", + "description": "the state of the project", + "name": "state", "type": "string" }, { - "description": "the total number of public ip addresses this project can acquire", - "name": "iplimit", + "description": "the total object storage space (in GiB) available to the project", + "name": "objectstorageavailable", "type": "string" }, { @@ -75002,60 +75259,54 @@ "type": "long" }, { - "description": "the total number of virtual machines that can be deployed by this project", - "name": "vmlimit", - "type": "string" - }, - { - "description": "the total number of vpcs available to be created for this project", - "name": "vpcavailable", - "type": "string" + "description": "the total primary storage space (in GiB) owned by project", + "name": "primarystoragetotal", + "type": "long" }, { - "description": "the total number of gpus the project can own", - "name": "gpulimit", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the total number of gpus available to be created for this project", - "name": "gpuavailable", + "description": "the total number of virtual machines available for this project to acquire", + "name": "vmavailable", "type": "string" }, { - "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", + "type": "long" }, { - "description": "the total number of backups which can be stored by this project", - "name": "backuplimit", + "description": "the total number of cpu cores available to be created for this project", + "name": "cpuavailable", "type": "string" }, - {}, { - "description": "the total number of buckets available to this project", - "name": "bucketavailable", + "description": "the total number of vpcs the project can own", + "name": "vpclimit", "type": "string" }, { - "description": "the total number of snapshots which can be stored by this project", - "name": "snapshotlimit", + "description": "the total secondary storage space (in GiB) available to be used for this project", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "the total number of snapshots stored by this project", - "name": "snapshottotal", - "type": "long" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the total number of buckets which can be stored by this project", - "name": "bucketlimit", + "description": "the total object storage space (in GiB) the project can own", + "name": "objectstoragelimit", "type": "string" }, { - "description": "the total number of buckets stored by this project", - "name": "buckettotal", - "type": "long" + "description": "the total primary storage space (in GiB) available to be used for this project", + "name": "primarystorageavailable", + "type": "string" }, { "description": "the total number of networks available to be created for this project", @@ -75063,90 +75314,49 @@ "type": "string" }, { - "description": "the total object storage space (in GiB) available to the project", - "name": "objectstorageavailable", + "description": "the total number of snapshots which can be stored by this project", + "name": "snapshotlimit", "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", + "description": "the total number of vpcs owned by project", + "name": "vpctotal", "type": "long" }, { - "description": "the total number of backups available to this project", - "name": "backupavailable", - "type": "string" - }, - { - "description": "the total secondary storage space (in GiB) available to be used for this project", - "name": "secondarystorageavailable", - "type": "string" - }, - { - "description": "the id of the project", - "name": "id", + "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) the project can own", - "name": "secondarystoragelimit", + "description": "the total number of public ip addresses this project can acquire", + "name": "iplimit", "type": "string" }, { - "description": "the total number of virtual machines running for this project", - "name": "vmrunning", - "type": "integer" - }, - { - "description": "the displaytext of the project", - "name": "displaytext", + "description": "the total number of backups available to this project", + "name": "backupavailable", "type": "string" }, - { - "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 total number of networks owned by project", "name": "networktotal", "type": "long" }, { - "description": "the total number of public ip addresses available for this project to acquire", - "name": "ipavailable", - "type": "string" + "description": "the total secondary storage space (in GiB) owned by project", + "name": "secondarystoragetotal", + "type": "float" }, { - "description": "the total number of cpu cores the project can own", - "name": "cpulimit", + "description": "the total backup storage space (in GiB) available to the project", + "name": "backupstorageavailable", "type": "string" }, { - "description": "the total number of vpcs owned by project", - "name": "vpctotal", - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ], "since": "3.0.0" @@ -75166,8 +75376,6 @@ } ], "response": [ - {}, - {}, { "description": "any text associated with the success or failure", "name": "displaytext", @@ -75178,16 +75386,18 @@ "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" - } + {} ] }, { @@ -75196,11 +75406,12 @@ "name": "prepareForMaintenance", "params": [ { - "description": "indirect agents load balancer algorithm (static, roundrobin, shuffle); when this is not set, already configured algorithm from setting 'indirect.agent.lb.algorithm' is considered", + "description": "the id of the management server", "length": 255, - "name": "algorithm", - "required": false, - "type": "string" + "name": "managementserverid", + "related": "listManagementServers", + "required": true, + "type": "uuid" }, { "description": "Force management server to maintenance after the maintenance window timeout, default is false", @@ -75210,67 +75421,66 @@ "type": "boolean" }, { - "description": "the id of the management server", + "description": "indirect agents load balancer algorithm (static, roundrobin, shuffle); when this is not set, already configured algorithm from setting 'indirect.agent.lb.algorithm' is considered", "length": 255, - "name": "managementserverid", - "related": "listManagementServers", - "required": true, - "type": "uuid" + "name": "algorithm", + "required": false, + "type": "string" } ], "related": "prepareForShutdown,cancelShutdown,readyForShutdown", "response": [ { - "description": "the state of the management server", - "name": "state", - "type": "state" + "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 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 UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "The number of jobs in progress", "name": "pendingjobscount", "type": "long" }, + { + "description": "the state of the management server", + "name": "state", + "type": "state" + }, + { + "description": "The number of host agents this management server is responsible for", + "name": "agentscount", + "type": "long" + }, { "description": "Indicates whether a shutdown has been triggered", "name": "shutdowntriggered", "type": "boolean" }, + {}, { "description": "Indicates whether CloudStack is ready to shutdown", "name": "readyforshutdown", "type": "boolean" }, { - "description": "Indicates whether maintenance has been initiated", - "name": "maintenanceinitiated", - "type": "boolean" - }, - { - "description": "The id of the management server", - "name": "managementserverid", + "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" } ], "since": "4.21.0" @@ -75288,13 +75498,6 @@ "required": false, "type": "list" }, - { - "description": "end date range to delete alerts (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")", - "length": 255, - "name": "enddate", - "required": false, - "type": "date" - }, { "description": "delete by alert type", "length": 255, @@ -75308,10 +75511,21 @@ "name": "startdate", "required": false, "type": "date" + }, + { + "description": "end date range to delete alerts (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")", + "length": 255, + "name": "enddate", + "required": false, + "type": "date" } ], "response": [ - {}, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, {}, { "description": "the UUID of the latest async job acting on this object", @@ -75319,20 +75533,16 @@ "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" - } + {} ] }, { @@ -75341,19 +75551,12 @@ "name": "createAutoScaleVmProfile", "params": [ { - "description": "an optional binary data that can be sent to the virtual machine upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST (via POST body), you can send up to 1MB of data after base64 encoding. You also need to change vm.userdata.max.length value", - "length": 1048576, - "name": "userdata", - "required": false, - "since": "4.18.0", - "type": "string" - }, - { - "description": "domain ID of the account owning a autoscale VM profile", + "description": "the ID of the Userdata", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains,moveDomain", + "name": "userdataid", + "related": "listCniConfiguration", "required": false, + "since": "4.18.1", "type": "uuid" }, { @@ -75364,6 +75567,21 @@ "required": false, "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": "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" + }, { "description": "the time allowed for existing connections to get closed before a vm is expunged", "length": 255, @@ -75372,20 +75590,19 @@ "type": "integer" }, { - "description": "the ID of the Userdata", + "description": "an optional field, whether to the display the profile to the end user or not", "length": 255, - "name": "userdataid", - "related": "listCniConfiguration", + "name": "fordisplay", "required": false, - "since": "4.18.1", - "type": "uuid" + "since": "4.4", + "type": "boolean" }, { - "description": "availability zone for the auto deployed virtual machine", + "description": "domain ID of the account owning a autoscale VM profile", "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, + "name": "domainid", + "related": "createDomain,listDomains,listDomains,moveDomain", + "required": false, "type": "uuid" }, { @@ -75396,17 +75613,18 @@ "type": "map" }, { - "description": "counterparam list. Example: counterparam[0].name=snmpcommunity&counterparam[0].value=public&counterparam[1].name=snmpport&counterparam[1].value=161", + "description": "an optional project for the autoscale VM profile", "length": 255, - "name": "counterparam", + "name": "projectid", + "related": "createProject", "required": false, - "type": "map" + "type": "uuid" }, { - "description": "the service offering of the auto deployed virtual machine", + "description": "availability zone for the auto deployed virtual machine", "length": 255, - "name": "serviceofferingid", - "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", + "name": "zoneid", + "related": "listZones", "required": true, "type": "uuid" }, @@ -75418,87 +75636,62 @@ "type": "string" }, { - "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", - "required": true, - "type": "uuid" - }, - { - "description": "an optional project for the autoscale VM profile", + "description": "used to specify the parameters values for the variables in userdata.", "length": 255, - "name": "projectid", - "related": "createProject", + "name": "userdatadetails", "required": false, - "type": "uuid" + "since": "4.18.1", + "type": "map" }, { - "description": "an optional field, whether to the display the profile to the end user or not", + "description": "the template of the auto deployed virtual machine", "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" + "name": "templateid", + "related": "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": "used to specify the parameters values for the variables in userdata.", - "length": 255, - "name": "userdatadetails", + "description": "an optional binary data that can be sent to the virtual machine upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST (via POST body), you can send up to 1MB of data after base64 encoding. You also need to change vm.userdata.max.length value", + "length": 1048576, + "name": "userdata", "required": false, - "since": "4.18.1", - "type": "map" + "since": "4.18.0", + "type": "string" } ], "related": "listAutoScaleVmProfiles,updateAutoScaleVmProfile", "response": [ { - "description": "the project id vm profile", - "name": "projectid", - "type": "string" + "description": "the time allowed for existing connections to get closed before a vm is destroyed", + "name": "expungevmgraceperiod", + "type": "integer" }, - {}, { "description": "the domain name of the vm profile", "name": "domain", "type": "string" }, { - "description": "the autoscale vm profile ID", - "name": "id", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "the domain ID of the vm profile", - "name": "domainid", - "type": "string" + "description": "is profile for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, - {}, { "description": "path of the domain to which the vm profile belongs", "name": "domainpath", "type": "string" }, - { - "description": "parameters other than zoneId/serviceOfferringId/templateId to be used while deploying a virtual machine", - "name": "otherdeployparams", - "type": "map" - }, { "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": "the service offering to be used while deploying a virtual machine", "name": "serviceofferingid", @@ -75506,61 +75699,78 @@ }, {}, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "the account owning the instance group", + "name": "account", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Base64 encoded VM user data", + "name": "userdata", "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "the template to be used while deploying a virtual machine", - "name": "templateid", + "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 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", + "description": "the domain ID of the vm profile", + "name": "domainid", "type": "string" }, { - "description": "Base64 encoded VM user data", - "name": "userdata", + "description": "the autoscale vm profile ID", + "name": "id", "type": "string" }, { - "description": "the account owning the instance group", - "name": "account", + "description": "the project id vm profile", + "name": "projectid", "type": "string" }, + {}, + {}, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "the template to be used while deploying a virtual machine", + "name": "templateid", "type": "string" }, + {}, { - "description": "the time allowed for existing connections to get closed before a vm is destroyed", - "name": "expungevmgraceperiod", - "type": "integer" + "description": "parameters other than zoneId/serviceOfferringId/templateId to be used while deploying a virtual machine", + "name": "otherdeployparams", + "type": "map" + }, + { + "description": "the 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 ID of the user used to launch and destroy the VMs", "name": "autoscaleuserid", "type": "string" - }, - {} + } ] }, { @@ -75568,13 +75778,6 @@ "isasync": false, "name": "registerOauthProvider", "params": [ - { - "description": "Client ID pre-registered in the specific OAuth provider", - "length": 255, - "name": "clientid", - "required": true, - "type": "string" - }, { "description": "Secret Key pre-registered in the specific OAuth provider", "length": 255, @@ -75590,16 +75793,16 @@ "type": "string" }, { - "description": "Description of the OAuth Provider", + "description": "Redirect URI pre-registered in the specific OAuth provider", "length": 255, - "name": "description", + "name": "redirecturi", "required": true, "type": "string" }, { - "description": "Redirect URI pre-registered in the specific OAuth provider", + "description": "Client ID pre-registered in the specific OAuth provider", "length": 255, - "name": "redirecturi", + "name": "clientid", "required": true, "type": "string" }, @@ -75609,15 +75812,28 @@ "name": "details", "required": false, "type": "map" + }, + { + "description": "Description of the OAuth Provider", + "length": 255, + "name": "description", + "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", "type": "integer" }, + {}, { "description": "true if operation is executed successfully", "name": "success", @@ -75627,136 +75843,98 @@ "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" }, { - "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": "New NUMA node of the GPU device", "length": 255, - "name": "page", + "name": "numanode", "required": false, - "type": "integer" + "type": "string" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "New type of GPU device (PCI, MDEV, VGPUOnly)", "length": 255, - "name": "fordisplay", + "name": "type", "required": false, - "since": "4.4", - "type": "boolean" + "type": "string" }, { - "description": "List by keyword", + "description": "New vGPU profile ID", "length": 255, - "name": "keyword", + "name": "vgpuprofileid", + "related": "createVgpuProfile,updateVgpuProfile", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "", + "description": "New parent GPU device ID (for virtual GPU devices)", "length": 255, - "name": "pagesize", + "name": "parentgpudeviceid", + "related": "listGpuDevices,listGpuDevices,discoverGpuDevices,createGpuDevice,updateGpuDevice", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "the ID of the load balancer stickiness policy", + "description": "ID of the GPU device to update", "length": 255, "name": "id", - "related": "createLBStickinessPolicy,listLBStickinessPolicies,updateLBStickinessPolicy", - "required": false, + "related": "listGpuDevices,listGpuDevices,discoverGpuDevices,createGpuDevice,updateGpuDevice", + "required": true, "type": "uuid" } ], - "related": "createLBStickinessPolicy,updateLBStickinessPolicy", + "related": "listGpuDevices,listGpuDevices,discoverGpuDevices,createGpuDevice", "response": [ { - "description": "the domain of the Stickiness policy", - "name": "domain", + "description": "the vGPU profile name assigned to this GPU device", + "name": "state", + "type": "state" + }, + { + "description": "the GPU card name associated with this GPU device", + "name": "gpucardname", "type": "string" }, { - "description": "the domain ID of the Stickiness policy", - "name": "domainid", + "description": "the vGPU profile name assigned to this GPU device", + "name": "vgpuprofilename", "type": "string" }, { - "description": "the state of the policy", - "name": "state", + "description": "the NUMA node where the GPU device is located", + "name": "numanode", "type": "string" }, { - "description": "the name of the Stickiness policy", - "name": "name", + "description": "the host ID where the GPU device is attached", + "name": "hostid", "type": "string" }, { - "description": "the description of the Stickiness policy", - "name": "description", + "description": "the GPU card ID associated with this GPU device", + "name": "gpucardid", "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 ID of the parent GPU device, if this is a vGPU", + "name": "parentgpudeviceid", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", @@ -75764,106 +75942,163 @@ "type": "string" }, { - "description": "the LB rule ID", - "name": "lbruleid", + "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 current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the id of the zone the Stickiness policy belongs to", - "name": "zoneid", + "description": "the vGPU profile ID assigned to this GPU device", + "name": "virtualmachineid", "type": "string" }, { - "description": "the account of the Stickiness policy", - "name": "account", + "description": "bus address of the GPU device or MDEV UUID for vGPU devices", + "name": "busaddress", "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": "virtualmachinename", + "type": "string" + }, + { + "description": "the ID of the GPU device", + "name": "id", + "type": "string" + }, + { + "description": "the host name where the GPU device is attached", + "name": "hostname", + "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": "the ID of the load balancer stickiness policy", "length": 255, - "name": "gpucardid", - "related": "listGpuCards", + "name": "id", + "related": "createLBStickinessPolicy,listLBStickinessPolicies,updateLBStickinessPolicy", "required": false, "type": "uuid" }, { - "description": "New NUMA node of the GPU device", + "description": "List by keyword", "length": 255, - "name": "numanode", + "name": "keyword", "required": false, "type": "string" }, { - "description": "ID of the GPU device to update", + "description": "", "length": 255, - "name": "id", - "related": "listGpuDevices,listGpuDevices,discoverGpuDevices,createGpuDevice,updateGpuDevice", - "required": true, - "type": "uuid" + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "New type of GPU device (PCI, MDEV, VGPUOnly)", + "description": "the ID of the load balancer rule", "length": 255, - "name": "type", + "name": "lbruleid", + "related": "listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "New parent GPU device ID (for virtual GPU devices)", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "parentgpudeviceid", - "related": "listGpuDevices,listGpuDevices,discoverGpuDevices,createGpuDevice,updateGpuDevice", + "name": "fordisplay", "required": false, - "type": "uuid" + "since": "4.4", + "type": "boolean" } ], - "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", + "description": "the account of the Stickiness policy", + "name": "account", "type": "string" }, { - "description": "the state of the virtual machine to which this GPU device is allocated", - "name": "vmstate", - "type": "state" + "description": "the list of stickinesspolicies", + "name": "stickinesspolicy", + "response": [ + { + "description": "the params of the policy", + "name": "params", + "type": "map" + }, + { + "description": "the state of the policy", + "name": "state", + "type": "string" + }, + { + "description": "the name of the Stickiness policy", + "name": "name", + "type": "string" + }, + { + "description": "the method name of the Stickiness policy", + "name": "methodname", + "type": "string" + }, + { + "description": "the description of the Stickiness policy", + "name": "description", + "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" + } + ], + "type": "list" }, { - "description": "the ID of the GPU device", - "name": "id", + "description": "the LB rule ID", + "name": "lbruleid", "type": "string" }, { @@ -75871,70 +76106,45 @@ "name": "jobid", "type": "string" }, - {}, { - "description": "the vGPU profile ID assigned to this GPU device", - "name": "virtualmachineid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the NUMA node where the GPU device is located", - "name": "numanode", + "description": "the description of the Stickiness policy", + "name": "description", "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", - "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 vGPU profile name assigned to this GPU device", - "name": "virtualmachinename", + "description": "the domain ID of the Stickiness policy", + "name": "domainid", "type": "string" }, + {}, { - "description": "the GPU card ID associated with this GPU device", - "name": "gpucardid", + "description": "the state of the policy", + "name": "state", "type": "string" }, { - "description": "the vGPU profile name assigned to this GPU device", - "name": "vgpuprofilename", + "description": "the name of the Stickiness policy", + "name": "name", "type": "string" }, { - "description": "the host ID where the GPU device is attached", - "name": "hostid", + "description": "the id of the zone the Stickiness policy belongs to", + "name": "zoneid", "type": "string" }, { - "description": "the GPU card name associated with this GPU device", - "name": "gpucardname", + "description": "the domain of the Stickiness policy", + "name": "domain", "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,9 +76152,17 @@ "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": "uuid" + }, + { + "description": "the name of UCS url", + "length": 255, + "name": "url", "required": true, "type": "string" }, @@ -75956,46 +76174,23 @@ "type": "string" }, { - "description": "the username of UCS", + "description": "the password of UCS", "length": 255, - "name": "username", + "name": "password", "required": true, "type": "string" }, { - "description": "the name of UCS url", + "description": "the username of UCS", "length": 255, - "name": "url", + "name": "username", "required": true, "type": "string" - }, - { - "description": "the Zone id for the ucs manager", - "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, - "type": "uuid" } ], "related": "listUcsManagers", "response": [ - { - "description": "the 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", - "name": "jobid", - "type": "string" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -76006,12 +76201,27 @@ "name": "id", "type": "string" }, + { + "description": "the zone ID of ucs manager", + "name": "zoneid", + "type": "string" + }, { "description": "the name of ucs manager", "name": "name", "type": "string" }, - {} + { + "description": "the url of ucs manager", + "name": "url", + "type": "string" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } ] }, { @@ -76035,14 +76245,6 @@ "required": false, "type": "uuid" }, - { - "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", - "required": true, - "type": "uuid" - }, { "description": "Force delete a template.", "length": 255, @@ -76050,6 +76252,14 @@ "required": false, "since": "4.9+", "type": "boolean" + }, + { + "description": "the ID of the template", + "length": 255, + "name": "id", + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "required": true, + "type": "uuid" } ], "response": [ @@ -76061,9 +76271,9 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { "description": "any text associated with the success or failure", @@ -76071,9 +76281,9 @@ "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" @@ -76084,33 +76294,33 @@ "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": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "netscaler load balancer device ID", + "description": "", "length": 255, - "name": "lbdeviceid", - "related": "addNetscalerLoadBalancer,configureNetscalerLoadBalancer,listNetscalerLoadBalancers,registerNetscalerControlCenter,deployNetscalerVpx", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { "description": "the Physical Network ID", @@ -76124,91 +76334,91 @@ "related": "addNetscalerLoadBalancer,configureNetscalerLoadBalancer,registerNetscalerControlCenter,deployNetscalerVpx", "response": [ { - "description": "device capacity", - "name": "lbdevicecapacity", - "type": "long" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "device state", + "name": "lbdevicestate", "type": "string" }, { - "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": "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", + "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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "device id of the netscaler load balancer", + "name": "lbdeviceid", + "type": "string" }, - {}, { "description": "device name", "name": "lbdevicename", "type": "string" }, { - "description": "true if NetScaler device is provisioned exclusively to be a GSLB service provider", - "name": "isexclusivegslbprovider", - "type": "boolean" + "description": "private IP of the NetScaler representing GSLB site", + "name": "gslbproviderprivateip", + "type": "string" + }, + { + "description": "Used when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device.", + "name": "podids", + "type": "list" }, { "description": "the public interface of the load balancer", "name": "publicinterface", "type": "string" }, - {}, { - "description": "the management IP address of the external load balancer", - "name": "ipaddress", + "description": "the private interface of the load balancer", + "name": "privateinterface", "type": "string" }, { - "description": "name of the provider", - "name": "provider", + "description": "the physical network to which this netscaler device belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the private interface of the load balancer", - "name": "privateinterface", - "type": "string" + "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": "true if NetScaler device is provisioned to be a GSLB service provider", + "name": "gslbprovider", + "type": "boolean" }, { - "description": "device id of the netscaler load balancer", - "name": "lbdeviceid", + "description": "name of the provider", + "name": "provider", "type": "string" }, { - "description": "device state", - "name": "lbdevicestate", - "type": "string" + "description": "device capacity", + "name": "lbdevicecapacity", + "type": "long" }, { - "description": "the physical network to which this netscaler device belongs to", - "name": "physicalnetworkid", + "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": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -76256,8 +76466,13 @@ "type": "string" }, { - "description": "the domain name of the instance group", - "name": "domain", + "description": "path of the Domain the instance group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -76266,51 +76481,46 @@ "type": "date" }, { - "description": "path of the Domain the instance group belongs to", - "name": "domainpath", + "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 ID of the instance group", + "name": "domainid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the domain name of the instance group", + "name": "domain", + "type": "string" }, { - "description": "the project ID of the instance group", - "name": "projectid", + "description": "the name of the instance group", + "name": "name", "type": "string" }, { - "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", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the name of the instance group", - "name": "name", + "description": "the project ID of the instance group", + "name": "projectid", "type": "string" }, - {}, { - "description": "the account owning the instance group", - "name": "account", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -76320,19 +76530,11 @@ "name": "createLoadBalancer", "params": [ { - "description": "the description of the load balancer", - "length": 4096, - "name": "description", - "required": false, - "type": "string" - }, - { - "description": "The guest network the load balancer will be created for", + "description": "the load balancer scheme. Supported value in this release is Internal", "length": 255, - "name": "networkid", - "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", + "name": "scheme", "required": true, - "type": "uuid" + "type": "string" }, { "description": "an optional field, whether to the display the rule to the end user or not", @@ -76343,23 +76545,23 @@ "type": "boolean" }, { - "description": "the load balancer scheme. Supported value in this release is Internal", - "length": 255, - "name": "scheme", - "required": true, + "description": "the description of the load balancer", + "length": 4096, + "name": "description", + "required": false, "type": "string" }, { - "description": "name of the load balancer", + "description": "the TCP port of the virtual machine where the network traffic will be load balanced to", "length": 255, - "name": "name", + "name": "instanceport", "required": true, - "type": "string" + "type": "integer" }, { - "description": "the TCP port of the virtual machine where the network traffic will be load balanced to", + "description": "the source port the network traffic will be load balanced from", "length": 255, - "name": "instanceport", + "name": "sourceport", "required": true, "type": "integer" }, @@ -76372,18 +76574,12 @@ "type": "uuid" }, { - "description": "the source port the network traffic will be load balanced from", - "length": 255, - "name": "sourceport", - "required": true, - "type": "integer" - }, - { - "description": "load balancer algorithm (source, roundrobin, leastconn)", + "description": "The guest network the load balancer will be created for", "length": 255, - "name": "algorithm", + "name": "networkid", + "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", "required": true, - "type": "string" + "type": "uuid" }, { "description": "the source IP address the network traffic will be load balanced from", @@ -76391,33 +76587,32 @@ "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", + "description": "name of the load balancer", + "length": 255, "name": "name", + "required": true, "type": "string" }, { - "description": "Load Balancer network id", - "name": "networkid", + "description": "load balancer algorithm (source, roundrobin, leastconn)", + "length": 255, + "name": "algorithm", + "required": true, "type": "string" - }, + } + ], + "related": "", + "response": [ { - "description": "the project name of the Load Balancer", - "name": "project", + "description": "the Load Balancer ID", + "name": "id", "type": "string" }, { - "description": "Load Balancer source ip", - "name": "sourceipaddress", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -76425,25 +76620,57 @@ "name": "algorithm", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Load Balancer source ip network id", + "name": "sourceipaddressnetworkid", "type": "string" }, + {}, { - "description": "the Load Balancer ID", - "name": "id", + "description": "the description of the Load Balancer", + "name": "description", "type": "string" }, + { + "description": "the list of instances associated with the Load Balancer", + "name": "loadbalancerinstance", + "response": [ + { + "description": "the instance ID", + "name": "id", + "type": "string" + }, + { + "description": "the state of the instance", + "name": "state", + "type": "string" + }, + { + "description": "the name of the instance", + "name": "name", + "type": "string" + }, + { + "description": "the ip address of the instance", + "name": "ipaddress", + "type": "string" + } + ], + "type": "list" + }, { "description": "the domain of the Load Balancer", "name": "domain", "type": "string" }, { - "description": "Load Balancer source ip network id", - "name": "sourceipaddressnetworkid", + "description": "path of the domain to which the Load Balancer belongs", + "name": "domainpath", + "type": "string" + }, + { + "description": "Load Balancer source ip", + "name": "sourceipaddress", "type": "string" }, { @@ -76452,58 +76679,59 @@ "type": "string" }, { - "description": "the domain ID of the Load Balancer", - "name": "domainid", - "type": "string" + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the description of the Load Balancer", - "name": "description", + "description": "Load Balancer network id", + "name": "networkid", "type": "string" }, - {}, { - "description": "the list of resource tags associated with the Load Balancer", - "name": "tags", + "description": "the list of rules associated with the Load Balancer", + "name": "loadbalancerrule", "response": [ { - "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": "instance port of the load balancer rule", + "name": "instanceport", + "type": "integer" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the state of the load balancer rule", + "name": "state", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, + "description": "source port of the load balancer rule", + "name": "sourceport", + "type": "integer" + } + ], + "type": "list" + }, + { + "description": "the domain ID of the Load Balancer", + "name": "domainid", + "type": "string" + }, + { + "description": "the list of resource tags associated with the Load Balancer", + "name": "tags", + "response": [ { "description": "the project id the tag belongs to", "name": "projectid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -76511,82 +76739,64 @@ "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" - } - ], - "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 project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the name of the instance", - "name": "name", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the instance ID", - "name": "id", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the ip address of the instance", - "name": "ipaddress", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" - } - ], - "type": "list" - }, - { - "description": "the list of rules associated with the Load Balancer", - "name": "loadbalancerrule", - "response": [ - { - "description": "source port of the load balancer rule", - "name": "sourceport", - "type": "integer" }, { - "description": "the state of the load balancer rule", - "name": "state", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "instance port of the load balancer rule", - "name": "instanceport", - "type": "integer" + "description": "customer associated with the tag", + "name": "customer", + "type": "string" } ], "type": "list" }, + {}, { "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 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" } ], "since": "4.2.0" @@ -76596,6 +76806,13 @@ "isasync": false, "name": "updateBackupSchedule", "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, @@ -76607,10 +76824,18 @@ "description": "ID of the VM for which schedule is to be defined", "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", + "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,createVMFromBackup,createVMFromBackup,assignVirtualMachine,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "required": true, "type": "uuid" }, + { + "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": "valid values are HOURLY, DAILY, WEEKLY, and MONTHLY", "length": 255, @@ -76625,94 +76850,80 @@ "required": false, "since": "4.21.0", "type": "integer" - }, - { - "description": "Quiesce the instance before checkpointing the disks for backup. Applicable only to NAS backup provider. The filesystem is frozen before the backup starts and thawed immediately after. Requires the instance to have the QEMU Guest Agent installed and running.", - "length": 255, - "name": "quiescevm", - "required": false, - "since": "4.21.0", - "type": "boolean" - }, - { - "description": "Specifies a timezone for this command. For more information on the timezone parameter, see TimeZone Format.", - "length": 255, - "name": "timezone", - "required": true, - "type": "string" } ], "related": "", "response": [ { - "description": "domain name", - "name": "domain", - "type": "string" + "description": "backup date", + "name": "created", + "type": "date" }, { - "description": "name of the VM", - "name": "virtualmachinename", + "description": "Interval type of the backup", + "name": "intervaltype", "type": "string" }, { - "description": "backup size in bytes", - "name": "size", - "type": "long" + "description": "backup offering id", + "name": "backupofferingid", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "backup offering name", + "name": "backupofferingname", + "type": "string" }, { - "description": "backup status", - "name": "status", - "type": "status" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "name of the backup", - "name": "name", - "type": "string" + "description": "The backup offering corresponding to this backup was removed from the VM", + "name": "vmbackupofferingremoved", + "type": "boolean" }, { - "description": "backup date", - "name": "created", - "type": "date" + "description": "name of the VM", + "name": "virtualmachinename", + "type": "string" }, { - "description": "ID of the VM backup", - "name": "id", + "description": "backed up volumes", + "name": "volumes", "type": "string" }, + {}, { - "description": "Lists the vm specific details for the backup", - "name": "vmdetails", - "type": "map" + "description": "account id", + "name": "accountid", + "type": "string" }, { - "description": "The backup offering corresponding to this backup was removed from the VM", - "name": "vmbackupofferingremoved", + "description": "Indicates whether the VM from which the backup was taken is expunged or not", + "name": "isbackupvmexpunged", "type": "boolean" }, { - "description": "backup offering name", - "name": "backupofferingname", + "description": "domain id", + "name": "domainid", "type": "string" }, { - "description": "backup protected (virtual) size in bytes", - "name": "virtualsize", - "type": "long" + "description": "external backup id", + "name": "externalid", + "type": "string" }, { - "description": "backup offering id", - "name": "backupofferingid", + "description": "backup type", + "name": "type", "type": "string" }, { - "description": "description for the backup", - "name": "description", - "type": "string" + "description": "Lists the vm specific details for the backup", + "name": "vmdetails", + "type": "map" }, { "description": "account name", @@ -76720,38 +76931,38 @@ "type": "string" }, { - "description": "Interval type of the backup", - "name": "intervaltype", - "type": "string" + "description": "backup size in bytes", + "name": "size", + "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "backup protected (virtual) size in bytes", + "name": "virtualsize", + "type": "long" }, { - "description": "zone name", - "name": "zone", + "description": "ID of the VM backup", + "name": "id", "type": "string" }, { - "description": "account id", - "name": "accountid", + "description": "domain name", + "name": "domain", "type": "string" }, { - "description": "domain id", - "name": "domainid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "external backup id", - "name": "externalid", + "description": "name of the backup", + "name": "name", "type": "string" }, { - "description": "backup type", - "name": "type", + "description": "description for the backup", + "name": "description", "type": "string" }, { @@ -76759,16 +76970,20 @@ "name": "zoneid", "type": "string" }, + {}, { - "description": "ID of the VM", - "name": "virtualmachineid", + "description": "backup status", + "name": "status", + "type": "status" + }, + { + "description": "zone name", + "name": "zone", "type": "string" }, - {}, - {}, { - "description": "backed up volumes", - "name": "volumes", + "description": "ID of the VM", + "name": "virtualmachineid", "type": "string" } ], @@ -76779,13 +76994,6 @@ "isasync": true, "name": "addPaloAltoFirewall", "params": [ - { - "description": "Credentials to reach Palo Alto firewall device", - "length": 255, - "name": "password", - "required": true, - "type": "string" - }, { "description": "supports only PaloAltoFirewall", "length": 255, @@ -76801,6 +77009,13 @@ "required": true, "type": "uuid" }, + { + "description": "Credentials to reach Palo Alto firewall device", + "length": 255, + "name": "username", + "required": true, + "type": "string" + }, { "description": "URL of the Palo Alto appliance.", "length": 255, @@ -76811,7 +77026,7 @@ { "description": "Credentials to reach Palo Alto firewall device", "length": 255, - "name": "username", + "name": "password", "required": true, "type": "string" } @@ -76819,28 +77034,30 @@ "related": "configurePaloAltoFirewall,listPaloAltoFirewalls", "response": [ { - "description": "device id of the Palo Alto firewall", - "name": "fwdeviceid", + "description": "name of the provider", + "name": "provider", "type": "string" }, { - "description": "the usage interface of the external firewall", - "name": "usageinterface", + "description": "device name", + "name": "fwdevicename", "type": "string" }, + {}, { - "description": "the private interface of the external firewall", - "name": "privateinterface", + "description": "the public security zone of the external firewall", + "name": "publiczone", "type": "string" }, + {}, { - "description": "name of the provider", - "name": "provider", + "description": "device state", + "name": "fwdevicestate", "type": "string" }, { - "description": "the public interface of the external firewall", - "name": "publicinterface", + "description": "the physical network to which this Palo Alto firewall belongs to", + "name": "physicalnetworkid", "type": "string" }, { @@ -76849,51 +77066,49 @@ "type": "long" }, { - "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": "device name", - "name": "fwdevicename", + "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 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": "the management IP address of the external firewall", + "name": "ipaddress", + "type": "string" }, { - "description": "the physical network to which this Palo Alto firewall belongs to", - "name": "physicalnetworkid", + "description": "device id of the Palo Alto firewall", + "name": "fwdeviceid", "type": "string" }, { - "description": "device state", - "name": "fwdevicestate", + "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", - "name": "publiczone", + "description": "the usage interface of the external firewall", + "name": "usageinterface", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the private security zone of the external firewall", + "name": "privatezone", "type": "string" }, - {}, { - "description": "the management IP address of the external firewall", - "name": "ipaddress", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the zone ID of the external firewall", @@ -76901,13 +77116,13 @@ "type": "string" }, { - "description": "the number of times to retry requests to the external firewall", - "name": "numretries", + "description": "the timeout (in seconds) for requests to the external firewall", + "name": "timeout", "type": "string" }, { - "description": "the private security zone of the external firewall", - "name": "privatezone", + "description": "the public interface of the external firewall", + "name": "publicinterface", "type": "string" } ] @@ -76918,64 +77133,63 @@ "name": "createPrivateGateway", "params": [ { - "description": "the Physical Network ID the network belongs to", + "description": "the gateway of the Private gateway", "length": 255, - "name": "physicalnetworkid", - "related": "listPhysicalNetworks,updatePhysicalNetwork", - "required": false, - "type": "uuid" + "name": "gateway", + "required": true, + "type": "string" }, { - "description": "the uuid of the network offering to use for the private gateways network connection", + "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": "networkofferingid", - "related": "createNetworkOffering,updateNetworkOffering,listNetworkOfferings", + "name": "sourcenatsupported", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "the IP address of the Private gateaway", + "description": "the network implementation uri for the private gateway", "length": 255, - "name": "ipaddress", - "required": true, + "name": "vlan", + "required": false, "type": "string" }, { - "description": "the VPC network belongs to", + "description": "when true bypasses VLAN id/range overlap check during private gateway creation", "length": 255, - "name": "vpcid", - "related": "listVPCs,createVPC,listVPCs,updateVPC", - "required": true, - "type": "uuid" + "name": "bypassvlanoverlapcheck", + "required": false, + "type": "boolean" }, { - "description": "source NAT supported value. Default value false. If 'true' source NAT is enabled on the private gateway 'false': sourcenat is not supported", + "description": "the uuid of the network offering to use for the private gateways network connection", "length": 255, - "name": "sourcenatsupported", + "name": "networkofferingid", + "related": "createNetworkOffering,updateNetworkOffering,listNetworkOfferings", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "the gateway of the Private gateway", + "description": "The isolated network this private gateway is associated to.", "length": 255, - "name": "gateway", - "required": true, - "type": "string" + "name": "associatednetworkid", + "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", + "required": false, + "since": "4.17.0", + "type": "uuid" }, { - "description": "the netmask of the Private gateway", + "description": "the IP address of the Private gateaway", "length": 255, - "name": "netmask", + "name": "ipaddress", "required": true, "type": "string" }, { - "description": "The isolated network this private gateway is associated to.", + "description": "the VPC network belongs to", "length": 255, - "name": "associatednetworkid", - "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", - "required": false, - "since": "4.17.0", + "name": "vpcid", + "related": "listVPCs,createVPC,listVPCs,updateVPC", + "required": true, "type": "uuid" }, { @@ -76987,18 +77201,19 @@ "type": "uuid" }, { - "description": "the network implementation uri for the private gateway", + "description": "the netmask of the Private gateway", "length": 255, - "name": "vlan", - "required": false, + "name": "netmask", + "required": true, "type": "string" }, { - "description": "when true bypasses VLAN id/range overlap check during private gateway creation", + "description": "the Physical Network ID the network belongs to", "length": 255, - "name": "bypassvlanoverlapcheck", + "name": "physicalnetworkid", + "related": "listPhysicalNetworks,updatePhysicalNetwork", "required": false, - "type": "boolean" + "type": "uuid" } ], "related": "createPrivateGateway,listPrivateGateways", @@ -77008,40 +77223,24 @@ "name": "projectid", "type": "string" }, - { - "description": "the network implementation uri for the private gateway", - "name": "vlan", - "type": "string" - }, - { - "description": "path of the domain to which the private gateway belongs", - "name": "domainpath", - "type": "string" - }, - { - "description": "the private gateway's ip address", - "name": "ipaddress", - "type": "string" - }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the account associated with the private gateway", - "name": "account", + "description": "VPC id the private gateway belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the ID of the domain associated with the private gateway", - "name": "domainid", + "description": "the account associated with the private gateway", + "name": "account", "type": "string" }, { - "description": "ACL Id set for private gateway", - "name": "aclid", + "description": "the private gateway's netmask", + "name": "netmask", "type": "string" }, { @@ -77050,48 +77249,60 @@ "type": "string" }, { - "description": "Source Nat enable status", - "name": "sourcenatsupported", - "type": "boolean" + "description": "zone id of the private gateway", + "name": "zoneid", + "type": "string" }, { - "description": "ACL name set for private gateway", - "name": "aclname", + "description": "the id of the private gateway", + "name": "id", "type": "string" }, { - "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 id of the private gateway", - "name": "id", + "description": "path of the domain to which the private gateway belongs", + "name": "domainpath", "type": "string" }, { - "description": "the gateway", - "name": "gateway", + "description": "the name of the Network associated with this private gateway", + "name": "associatednetwork", "type": "string" }, { - "description": "the domain associated with the private gateway", - "name": "domain", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "ACL Id set for private gateway", + "name": "aclid", "type": "string" }, { - "description": "the private gateway's netmask", - "name": "netmask", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the physical network id", - "name": "physicalnetworkid", + "description": "VPC name the private gateway belongs to", + "name": "vpcname", "type": "string" }, { - "description": "zone id of the private gateway", - "name": "zoneid", + "description": "Source Nat enable status", + "name": "sourcenatsupported", + "type": "boolean" + }, + {}, + { + "description": "the ID of the domain associated with the private gateway", + "name": "domainid", "type": "string" }, { @@ -77105,29 +77316,33 @@ "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the domain associated with the private gateway", + "name": "domain", + "type": "string" }, { - "description": "VPC name the private gateway belongs to", - "name": "vpcname", + "description": "ACL name set for private gateway", + "name": "aclname", "type": "string" }, { - "description": "the name of the Network associated with this private gateway", - "name": "associatednetwork", + "description": "the gateway", + "name": "gateway", "type": "string" }, { - "description": "the project name of the private gateway", - "name": "project", + "description": "the network implementation uri for the private gateway", + "name": "vlan", "type": "string" }, - {}, { - "description": "VPC id the private gateway belongs to", - "name": "vpcid", + "description": "the private gateway's ip address", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the project name of the private gateway", + "name": "project", "type": "string" } ], @@ -77148,9 +77363,10 @@ } ], "response": [ + {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -77158,17 +77374,16 @@ "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" } ] }, @@ -77178,19 +77393,12 @@ "name": "uploadSslCert", "params": [ { - "description": "SSL certificate", + "description": "Private key", "length": 16384, - "name": "certificate", + "name": "privatekey", "required": true, "type": "string" }, - { - "description": "Password for the private key", - "length": 255, - "name": "password", - "required": false, - "type": "string" - }, { "description": "account that will own the SSL certificate", "length": 255, @@ -77206,6 +77414,13 @@ "required": false, "type": "uuid" }, + { + "description": "SSL certificate", + "length": 16384, + "name": "certificate", + "required": true, + "type": "string" + }, { "description": "Certificate chain of trust", "length": 2097152, @@ -77214,10 +77429,10 @@ "type": "string" }, { - "description": "Name for the uploaded certificate", + "description": "Password for the private key", "length": 255, - "name": "name", - "required": true, + "name": "password", + "required": false, "type": "string" }, { @@ -77237,9 +77452,9 @@ "type": "boolean" }, { - "description": "Private key", - "length": 16384, - "name": "privatekey", + "description": "Name for the uploaded certificate", + "length": 255, + "name": "name", "required": true, "type": "string" } @@ -77247,40 +77462,46 @@ "related": "", "response": [ { - "description": "certificate fingerprint", - "name": "fingerprint", + "description": "the domain id of the network owner", + "name": "domainid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "SSL certificate ID", + "name": "id", + "type": "string" }, { - "description": "the project name of the certificate", - "name": "project", + "description": "the project id of the certificate", + "name": "projectid", "type": "string" }, { - "description": "certificate", - "name": "certificate", + "description": "certificate chain", + "name": "certchain", "type": "string" }, { - "description": "the project id of the certificate", - "name": "projectid", + "description": "the project name of the certificate", + "name": "project", "type": "string" }, { - "description": "the domain id of the network owner", - "name": "domainid", + "description": "certificate fingerprint", + "name": "fingerprint", "type": "string" }, { - "description": "the domain name of the network owner", - "name": "domain", + "description": "certificate", + "name": "certificate", "type": "string" }, + {}, + { + "description": "List of loabalancers this certificate is bound to", + "name": "loadbalancerrulelist", + "type": "list" + }, { "description": "name", "name": "name", @@ -77291,27 +77512,21 @@ "name": "account", "type": "string" }, - { - "description": "SSL certificate 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" }, - {}, { - "description": "certificate chain", - "name": "certchain", + "description": "the domain name of the network owner", + "name": "domain", "type": "string" }, { - "description": "List of loabalancers this certificate is bound to", - "name": "loadbalancerrulelist", - "type": "list" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ] }, @@ -77321,38 +77536,31 @@ "name": "updateOauthProvider", "params": [ { - "description": "id of the OAuth provider to be updated", - "length": 255, - "name": "id", - "related": "updateOauthProvider", - "required": true, - "type": "uuid" - }, - { - "description": "OAuth provider will be enabled or disabled based on this value", + "description": "Description of the OAuth Provider", "length": 255, - "name": "enabled", + "name": "description", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "Secret Key pre-registered in the specific OAuth provider", + "description": "Client ID pre-registered in the specific OAuth provider", "length": 255, - "name": "secretkey", + "name": "clientid", "required": false, "type": "string" }, { - "description": "Description of the OAuth Provider", + "description": "id of the OAuth provider to be updated", "length": 255, - "name": "description", - "required": false, - "type": "string" + "name": "id", + "related": "updateOauthProvider", + "required": true, + "type": "uuid" }, { - "description": "Client ID pre-registered in the specific OAuth provider", + "description": "Secret Key pre-registered in the specific OAuth provider", "length": 255, - "name": "clientid", + "name": "secretkey", "required": false, "type": "string" }, @@ -77362,16 +77570,29 @@ "name": "redirecturi", "required": false, "type": "string" + }, + { + "description": "OAuth provider will be enabled or disabled based on this value", + "length": 255, + "name": "enabled", + "required": false, + "type": "boolean" } ], "related": "", "response": [ { - "description": "Secret key registered in the OAuth provider", - "name": "secretkey", + "description": "Name of the provider", + "name": "provider", + "type": "string" + }, + { + "description": "ID of the provider", + "name": "id", "type": "string" }, {}, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -77388,19 +77609,14 @@ "type": "string" }, { - "description": "ID of the provider", - "name": "id", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Secret key registered in the OAuth provider", + "name": "secretkey", "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", @@ -77413,11 +77629,10 @@ "type": "string" }, { - "description": "Whether the OAuth provider is enabled or not", - "name": "enabled", - "type": "boolean" - }, - {} + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } ], "since": "4.19.0" }, @@ -77427,25 +77642,19 @@ "name": "createVpnCustomerGateway", "params": [ { - "description": "Lifetime of phase 2 VPN connection to the customer gateway, in seconds", + "description": "Lifetime of phase 1 VPN connection to the customer gateway, in seconds", "length": 255, - "name": "esplifetime", + "name": "ikelifetime", "required": false, "type": "long" }, { - "description": "guest cidr list of the customer gateway. Multiple entries must be separated by a single comma character (,).", - "length": 255, - "name": "cidrlist", - "required": true, - "type": "string" - }, - { - "description": "Force Encapsulation for NAT traversal", + "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": "forceencap", + "name": "domainid", + "related": "createDomain,listDomains,listDomains,moveDomain", "required": false, - "type": "boolean" + "type": "uuid" }, { "description": "create site-to-site VPN customer gateway for the project", @@ -77457,34 +77666,40 @@ "type": "uuid" }, { - "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": "the account associated with the gateway. Must be used with the domainId parameter.", "length": 255, - "name": "ikeversion", + "name": "account", "required": false, - "since": "4.15.1", "type": "string" }, { - "description": "IPsec Preshared-Key of the customer gateway. Cannot contain newline or double quotes.", + "description": "public ip address id of the customer gateway", "length": 255, - "name": "ipsecpsk", + "name": "gateway", "required": true, "type": "string" }, { - "description": "For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.", + "description": "Lifetime of phase 2 VPN connection to the customer gateway, in seconds", "length": 255, - "name": "splitconnections", + "name": "esplifetime", + "required": false, + "type": "long" + }, + { + "description": "Force Encapsulation for NAT traversal", + "length": 255, + "name": "forceencap", "required": false, - "since": "4.15.1", "type": "boolean" }, { - "description": "name of this customer gateway", + "description": "For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.", "length": 255, - "name": "name", + "name": "splitconnections", "required": false, - "type": "string" + "since": "4.15.1", + "type": "boolean" }, { "description": "ESP policy of the customer gateway", @@ -77494,86 +77709,71 @@ "type": "string" }, { - "description": "IKE policy of the customer gateway", + "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": "ikepolicy", - "required": true, + "name": "ikeversion", + "required": false, + "since": "4.15.1", "type": "string" }, { - "description": "Lifetime of phase 1 VPN connection to the customer gateway, in seconds", + "description": "If DPD is enabled for VPN connection", "length": 255, - "name": "ikelifetime", + "name": "dpd", "required": false, - "type": "long" + "type": "boolean" }, { - "description": "public ip address id of the customer gateway", + "description": "IKE policy of the customer gateway", "length": 255, - "name": "gateway", + "name": "ikepolicy", "required": true, "type": "string" }, { - "description": "If DPD is enabled for VPN connection", + "description": "IPsec Preshared-Key of the customer gateway. Cannot contain newline or double quotes.", "length": 255, - "name": "dpd", - "required": false, - "type": "boolean" + "name": "ipsecpsk", + "required": true, + "type": "string" }, { - "description": "the account associated with the gateway. Must be used with the domainId parameter.", + "description": "name of this customer gateway", "length": 255, - "name": "account", + "name": "name", "required": false, "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": "guest cidr list of the customer gateway. Multiple entries must be separated by a single comma character (,).", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains,moveDomain", - "required": false, - "type": "uuid" + "name": "cidrlist", + "required": true, + "type": "string" } ], "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": "Lifetime of IKE SA of customer gateway", + "name": "ikelifetime", + "type": "long" }, {}, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "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", - "type": "string" + "description": "For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.", + "name": "splitconnections", + "type": "boolean" }, { - "description": "IPsec preshared-key of customer gateway", - "name": "ipsecpsk", - "type": "string" + "description": "if Force NAT Encapsulation is enabled for customer gateway", + "name": "forceencap", + "type": "boolean" }, { "description": "name of the customer gateway", @@ -77581,34 +77781,29 @@ "type": "string" }, { - "description": "Lifetime of ESP SA of customer gateway", - "name": "esplifetime", - "type": "long" - }, - { - "description": "the owner", - "name": "account", + "description": "the domain id of the owner", + "name": "domainid", "type": "string" }, { - "description": "the vpn gateway ID", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "the domain path of the owner", + "name": "domainpath", + "type": "string" }, { - "description": "the domain name of the owner", - "name": "domain", + "description": "the vpn gateway ID", + "name": "id", "type": "string" }, { - "description": "Lifetime of IKE SA of customer gateway", - "name": "ikelifetime", - "type": "long" + "description": "if DPD is enabled for customer gateway", + "name": "dpd", + "type": "boolean" }, { "description": "the project name", @@ -77616,50 +77811,70 @@ "type": "string" }, { - "description": "if DPD is enabled for customer gateway", - "name": "dpd", + "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", + "name": "ikeversion", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, + { + "description": "the owner", + "name": "account", + "type": "string" + }, { "description": "IKE policy of customer gateway", "name": "ikepolicy", "type": "string" }, + { + "description": "the domain name of the owner", + "name": "domain", + "type": "string" + }, + {}, { "description": "public ip address id of the customer gateway", "name": "gateway", "type": "string" }, { - "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": "if Force NAT Encapsulation is enabled for customer gateway", - "name": "forceencap", - "type": "boolean" + "description": "IPsec preshared-key of customer gateway", + "name": "ipsecpsk", + "type": "string" }, { - "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": "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": "the date and time the host was removed", + "name": "removed", + "type": "date" + }, + { + "description": "the project id", + "name": "projectid", "type": "string" }, { - "description": "For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.", - "name": "splitconnections", - "type": "boolean" + "description": "IPsec policy of customer gateway", + "name": "esppolicy", + "type": "string" } ] }, @@ -77669,12 +77884,12 @@ "name": "addBaremetalHost", "params": [ { - "description": "the Zone ID for the host", + "description": "comma separated list of storage access groups for the host", "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, - "type": "uuid" + "name": "storageaccessgroups", + "required": false, + "since": "4.21.0", + "type": "list" }, { "description": "Allocation state of this Host for allocation of new resources", @@ -77684,64 +77899,63 @@ "type": "string" }, { - "description": "Details in key/value pairs using format externaldetails[i].keyname=keyvalue. Example: externaldetails[0].endpoint.url=urlvalue", + "description": "the cluster ID for the host", "length": 255, - "name": "externaldetails", + "name": "clusterid", + "related": "addCluster,updateCluster", "required": false, - "since": "4.21.0", - "type": "map" + "type": "uuid" }, { - "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": "the password for the host; required to be passed for hypervisors other than VMWare", "length": 255, - "name": "podid", - "related": "createPod,listPods,createManagementNetworkIpRange", - "required": true, - "type": "uuid" + "name": "password", + "required": false, + "type": "string" }, { - "description": "comma separated list of storage access groups for the host", + "description": "ip address intentionally allocated to this host after provisioning", "length": 255, - "name": "storageaccessgroups", + "name": "ipaddress", "required": false, - "since": "4.21.0", - "type": "list" + "type": "string" }, { - "description": "the host URL", + "description": "hypervisor type of the host", "length": 255, - "name": "url", + "name": "hypervisor", "required": true, "type": "string" }, { - "description": "the cluster name for the host", + "description": "the Pod ID for the host", "length": 255, - "name": "clustername", - "required": false, - "type": "string" + "name": "podid", + "related": "createPod,listPods,createManagementNetworkIpRange", + "required": true, + "type": "uuid" }, { - "description": "the cluster ID for the host", + "description": "the cluster name for the host", "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", + "name": "clustername", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "hypervisor type of the host", + "description": "the Zone ID for the host", "length": 255, - "name": "hypervisor", + "name": "zoneid", + "related": "listZones", "required": true, - "type": "string" + "type": "uuid" }, { "description": "list of tags to be added to the host", @@ -77751,16 +77965,17 @@ "type": "list" }, { - "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 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,19 +77983,19 @@ "related": "declareHostAsDegraded,listHosts,reconnectHost", "response": [ { - "description": "the state of the host", - "name": "state", - "type": "status" + "description": "the cluster ID of the host", + "name": "clusterid", + "type": "string" }, { - "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", + "description": "the amount of the host's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "true if the host is disconnected. False otherwise.", - "name": "disconnected", - "type": "date" + "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", @@ -77788,34 +78003,39 @@ "type": "boolean" }, { - "description": "comma-separated list of explicit host tags for the host", - "name": "explicithosttags", + "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": "comma-separated list of storage access groups on the pod", - "name": "podstorageaccessgroups", + "description": "comma-separated list of tags for the host", + "name": "hosttags", "type": "string" }, { - "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": "the host version", - "name": "version", + "description": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", "type": "string" }, { - "description": "the amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", - "type": "long" + "description": "the hypervisor version", + "name": "hypervisorversion", + "type": "string" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" + "description": "the date and time the host was last pinged", + "name": "lastpinged", + "type": "date" }, { "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", @@ -77823,140 +78043,203 @@ "type": "boolean" }, { - "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 host HA information information", - "name": "hostha", - "type": "hostharesponse" + "description": "the amount of the host's memory currently used", + "name": "memoryused", + "type": "long" }, - {}, { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", + "description": "GPU cards present in the host", + "name": "gpugroup", + "response": [ + { + "description": "the list of enabled vGPUs", + "name": "vgpu", + "response": [ + { + "description": "Video RAM for this vGPU type", + "name": "videoram", + "type": "long" + }, + { + "description": "Maximum displays per user", + "name": "maxheads", + "type": "long" + }, + { + "description": "Model Name of vGPU", + "name": "vgputype", + "type": "string" + }, + { + "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", + "name": "remainingcapacity", + "type": "long" + }, + { + "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", + "name": "maxcapacity", + "type": "long" + }, + { + "description": "Maximum Y resolution per display", + "name": "maxresolutiony", + "type": "long" + }, + { + "description": "Maximum X resolution per display", + "name": "maxresolutionx", + "type": "long" + }, + { + "description": "Maximum no. of vgpu per gpu card (pgpu)", + "name": "maxvgpuperpgpu", + "type": "long" + } + ], + "type": "list" + }, + { + "description": "GPU cards present in the host", + "name": "gpugroupname", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the admin that annotated this host", + "name": "username", "type": "string" }, { - "description": "capabilities of the host", - "name": "capabilities", + "description": "The ID of extension for this cluster", + "name": "extensionid", "type": "string" }, { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", - "type": "boolean" + "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": "the host type", + "name": "type", + "type": "type" }, { - "description": "the amount of the host's memory currently used", - "name": "memoryused", + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", "type": "long" }, { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the Zone name of the host", - "name": "zonename", + "description": "the virtual machine id for host type ConsoleProxy and SecondaryStorageVM", + "name": "virtualmachineid", "type": "string" }, { - "description": "comma-separated list of storage access groups for the host", - "name": "storageaccessgroups", + "description": "the cluster type of the cluster that host belongs to", + "name": "clustertype", "type": "string" }, { - "description": "the cluster name of the host", - "name": "clustername", + "description": "the ID of the host", + "name": "id", "type": "string" }, { - "description": "the OS category ID of the host", - "name": "oscategoryid", - "type": "string" + "description": "the number of CPU sockets on the host", + "name": "cpusockets", + "type": "integer" }, { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", + "description": "the cluster name of the host", + "name": "clustername", "type": "string" }, { - "description": "the admin that annotated this host", - "name": "username", - "type": "string" + "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "name": "memorytotal", + "type": "long" }, { - "description": "Used GPUs on the Host", - "name": "gpuused", + "description": "the total disk size of the host", + "name": "disksizetotal", "type": "long" }, { - "description": "the resource state of the host", - "name": "resourcestate", + "description": "capabilities of the host", + "name": "capabilities", "type": "string" }, { - "description": "the cluster ID of the host", - "name": "clusterid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "The name of extension for this cluster", + "name": "extensionname", "type": "string" }, { - "description": "the date and time the host was created", - "name": "created", - "type": "date" + "description": "true if the host supports encryption", + "name": "encryptionsupported", + "type": "boolean" }, { - "description": "CPU Arch of the host", - "name": "arch", - "type": "string" + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", + "type": "long" }, { - "description": "the ID of the host", - "name": "id", + "description": "the resource state of the host", + "name": "resourcestate", "type": "string" }, { - "description": "the Pod name of the host", - "name": "podname", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the last time this host was annotated", - "name": "lastannotated", - "type": "date" + "description": "comma-separated list of explicit host tags for the host", + "name": "explicithosttags", + "type": "string" }, { - "description": "the date and time the host was last pinged", - "name": "lastpinged", - "type": "date" + "description": "the incoming network traffic on the host", + "name": "networkkbsread", + "type": "long" }, { - "description": "the OS category name of the host", - "name": "oscategoryname", + "description": "the host hypervisor", + "name": "hypervisor", "type": "string" }, { - "description": "the last annotation set on this host by an admin", - "name": "annotation", + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", "type": "string" }, { - "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": "the Pod ID of the host", - "name": "podid", - "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 cluster", @@ -77964,58 +78247,48 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the amount of the host's CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", + "description": "CPU Arch of the host", + "name": "arch", "type": "string" }, { - "description": "comma-separated list of implicit host tags for the host", - "name": "implicithosttags", + "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": "true if the host supports instance conversion (using virt-v2v)", - "name": "instanceconversionsupported", - "type": "boolean" - }, - { - "description": "the name of the host", - "name": "name", - "type": "string" + "description": "Host details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the host hypervisor", - "name": "hypervisor", + "description": "comma-separated list of storage access groups on the zone", + "name": "zonestorageaccessgroups", "type": "string" }, { - "description": "the management server name of the host", - "name": "managementservername", + "description": "the Zone name of the host", + "name": "zonename", "type": "string" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", + "description": "Total GPUs on the Host", + "name": "gputotal", "type": "long" }, { - "description": "the management server ID of the host", - "name": "managementserverid", + "description": "comma-separated list of storage access groups on the pod", + "name": "podstorageaccessgroups", "type": "string" }, { - "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", + "description": "the state of the host", + "name": "state", + "type": "status" + }, + { + "description": "comma-separated list of implicit host tags for the host", + "name": "implicithosttags", "type": "string" }, { @@ -78023,191 +78296,133 @@ "name": "cpuloadaverage", "type": "double" }, + {}, { - "description": "the IP address of the host", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the Zone ID of the host", - "name": "zoneid", + "description": "comma-separated list of storage access groups for the host", + "name": "storageaccessgroups", "type": "string" }, { - "description": "events available for the host", - "name": "events", - "type": "string" + "description": "the CPU number of the host", + "name": "cpunumber", + "type": "integer" }, { - "description": "true if the host has capability to support UEFI boot", - "name": "ueficapability", + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the management server name of the host", + "name": "managementservername", "type": "string" }, { - "description": "GPU cards present in the host", - "name": "gpugroup", - "response": [ - { - "description": "GPU cards present in the host", - "name": "gpugroupname", - "type": "string" - }, - { - "description": "the list of enabled vGPUs", - "name": "vgpu", - "response": [ - { - "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", - "name": "maxcapacity", - "type": "long" - }, - { - "description": "Maximum Y resolution per display", - "name": "maxresolutiony", - "type": "long" - }, - { - "description": "Maximum displays per user", - "name": "maxheads", - "type": "long" - }, - { - "description": "Maximum X resolution per display", - "name": "maxresolutionx", - "type": "long" - }, - { - "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", - "name": "remainingcapacity", - "type": "long" - }, - { - "description": "Maximum no. of vgpu per gpu card (pgpu)", - "name": "maxvgpuperpgpu", - "type": "long" - }, - { - "description": "Model Name of vGPU", - "name": "vgputype", - "type": "string" - }, - { - "description": "Video RAM for this vGPU type", - "name": "videoram", - "type": "long" - } - ], - "type": "list" - } - ], - "type": "list" + "description": "the host HA information information", + "name": "hostha", + "type": "hostharesponse" }, { - "description": "Host details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the last time this host was annotated", + "name": "lastannotated", + "type": "date" }, { - "description": "The ID of extension for this cluster", - "name": "extensionid", + "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", "type": "string" }, { - "description": "the host type", - "name": "type", - "type": "type" - }, - { - "description": "the amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", + "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 amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", "type": "string" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", + "description": "Used GPUs on the Host", + "name": "gpuused", "type": "long" }, {}, { - "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": "the virtual machine id for host type ConsoleProxy and SecondaryStorageVM", - "name": "virtualmachineid", + "description": "the host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" + }, + { + "description": "the Pod name of the host", + "name": "podname", "type": "string" }, { - "description": "the hypervisor version", - "name": "hypervisorversion", + "description": "the name of the host", + "name": "name", "type": "string" }, { - "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", + "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 host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" + "description": "the CPU speed of the host", + "name": "cpuspeed", + "type": "long" }, { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", - "type": "boolean" + "description": "the Pod ID of the host", + "name": "podid", + "type": "string" }, { - "description": "true if the host supports encryption", - "name": "encryptionsupported", - "type": "boolean" + "description": "the IP address of the host", + "name": "ipaddress", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the amount of the host's memory currently allocated in bytes", + "name": "memoryallocatedbytes", + "type": "long" }, - {}, { "description": "the date and time the host was removed", "name": "removed", "type": "date" }, { - "description": "the CPU speed of the host", - "name": "cpuspeed", - "type": "long" - }, - { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", - "type": "long" + "description": "the date and time the host was created", + "name": "created", + "type": "date" }, { - "description": "The name of extension for this cluster", - "name": "extensionname", + "description": "the OS category name of the host", + "name": "oscategoryname", "type": "string" }, + {}, { - "description": "the number of CPU sockets on the host", - "name": "cpusockets", - "type": "integer" + "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", + "name": "cpuwithoverprovisioning", + "type": "string" }, { - "description": "comma-separated list of tags for the host", - "name": "hosttags", - "type": "string" + "description": "true if the host has capability to support UEFI boot", + "name": "ueficapability", + "type": "boolean" } ] }, @@ -78226,24 +78441,15 @@ ], "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", - "type": "string" - }, { "description": "The (uu)id of the user that entered the annotation", "name": "userid", "type": "string" }, + {}, { - "description": "The username of the user that entered the annotation", - "name": "username", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -78251,17 +78457,21 @@ "name": "created", "type": "date" }, - {}, + { + "description": "the (uu)id of the annotation", + "name": "id", + "type": "string" + }, {}, { - "description": "the name of the entity to which this annotation pertains", - "name": "entityname", + "description": "the type of the annotated entity", + "name": "entitytype", "type": "string" }, { - "description": "the removal timestamp for this annotation", - "name": "removed", - "type": "date" + "description": "the contents of the annotation", + "name": "annotation", + "type": "string" }, { "description": "the (uu)id of the entity to which this annotation pertains", @@ -78269,23 +78479,28 @@ "type": "string" }, { - "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": "the contents of the annotation", - "name": "annotation", - "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": "True if the annotation is available for admins only", + "name": "adminsonly", + "type": "boolean" }, { - "description": "the type of the annotated entity", - "name": "entitytype", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the name of the entity to which this annotation pertains", + "name": "entityname", "type": "string" } ], @@ -78306,17 +78521,11 @@ } ], "response": [ - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "true if operation is executed successfully", "name": "success", @@ -78327,7 +78536,13 @@ "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" }, @@ -78346,275 +78561,370 @@ } ], "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": "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": "start date from which the schedule becomes activeUse format \"yyyy-MM-dd hh:mm:ss\")", "length": 255, - "name": "iothreadsenabled", + "name": "startdate", "required": false, - "type": "boolean" + "type": "date" }, { - "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": "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": "datadisksdetails", + "name": "schedule", "required": false, - "since": "4.21.0", - "type": "map" + "type": "string" }, { - "description": "comma separated list of affinity groups id that are going to be applied to the virtual machine. Mutually exclusive with affinitygroupnames parameter", + "description": "end date after which the schedule becomes inactiveUse format \"yyyy-MM-dd hh:mm:ss\")", "length": 255, - "name": "affinitygroupids", - "related": "createAffinityGroup,listAffinityGroups", + "name": "enddate", "required": false, - "type": "list" + "type": "date" }, { - "description": "Boot into hardware setup or not (ignored if startVm = false, only valid for vmware)", + "description": "Specifies a timezone for this command. For more information on the timezone parameter, see TimeZone Format.", "length": 255, - "name": "bootintosetup", + "name": "timezone", + "required": false, + "type": "string" + }, + { + "description": "Enable VM schedule", + "length": 255, + "name": "enabled", "required": false, - "since": "4.15.0.0", "type": "boolean" }, { - "description": "an optional user generated name for the virtual machine", + "description": "Name of the schedule", "length": 255, - "name": "displayname", + "name": "description", "required": false, "type": "string" }, { - "description": "host name for the virtual machine", + "description": "ID of VM schedule", "length": 255, - "name": "name", - "required": false, + "name": "id", + "related": "updateVMSchedule", + "required": true, + "type": "uuid" + } + ], + "related": "", + "response": [ + {}, + { + "description": "Date after which the schedule becomes inactive", + "name": "enddate", + "type": "date" + }, + { + "description": "Timezone of the schedule", + "name": "timezone", "type": "string" }, { - "description": "Deploy vm for the project", + "description": "Action", + "name": "action", + "type": "action" + }, + { + "description": "Date when the schedule was created", + "name": "created", + "type": "date" + }, + { + "description": "Cron formatted VM schedule", + "name": "schedule", + "type": "string" + }, + {}, + { + "description": "Date from which the schedule is active", + "name": "startdate", + "type": "date" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "Description of VM schedule", + "name": "description", + "type": "string" + }, + { + "description": "the ID of VM schedule", + "name": "id", + "type": "string" + }, + { + "description": "ID of virtual machine", + "name": "virtualmachineid", + "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" + } + ], + "since": "4.19.0" + }, + { + "description": "Creates and automatically starts a VM from a backup.", + "isasync": true, + "name": "createVMFromBackup", + "params": [ + { + "description": "an optional field, whether to the display the vm to the end user or not.", "length": 255, - "name": "projectid", - "related": "createProject", + "name": "displayvm", "required": false, - "type": "uuid" + "since": "4.2", + "type": "boolean" }, { - "description": "the ID of the service offering for the virtual machine", + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "serviceofferingid", - "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", + "name": "customid", + "required": false, + "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, "type": "uuid" }, { - "description": "the ip address for default vm's network", + "description": "name of the ssh key pair used to login to the virtual machine", "length": 255, - "name": "ipaddress", + "name": "keypair", "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": "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": "the ipv6 address for default vm's network", "length": 255, - "name": "securitygroupnames", - "related": "updateSecurityGroup", + "name": "ip6address", "required": false, - "type": "list" + "type": "string" }, { - "description": "an optional URL encoded string that can be passed to the virtual machine upon successful deployment", - "length": 5120, - "name": "extraconfig", + "description": "host name for the virtual machine", + "length": 255, + "name": "name", "required": false, - "since": "4.12", "type": "string" }, { - "description": "destination Pod ID to deploy the VM to - parameter available for root admin only", + "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": "podid", - "related": "createPod,listPods,createManagementNetworkIpRange", + "name": "bootmode", "required": false, - "since": "4.21", - "type": "uuid" + "since": "4.14.0.0", + "type": "string" }, { - "description": "the ID of the template for the virtual machine", + "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": "templateid", - "related": "prepareTemplate,listIsos,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "name": "dhcpoptionsnetworklist", "required": false, - "type": "uuid" + "type": "map" }, { - "description": "the arbitrary size for the DATADISK volume. Mutually exclusive with diskOfferingId", + "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": "size", + "name": "rootdisksize", "required": false, + "since": "4.4", "type": "long" }, { - "description": "The number of queues for multiqueue NICs.", + "description": "if true the image tags (if any) will be copied to the VM, default value is false", "length": 255, - "name": "nicmultiqueuenumber", + "name": "copyimagetags", "required": false, - "since": "4.18", - "type": "integer" + "since": "4.13", + "type": "boolean" }, { - "description": "backup ID to create the VM from", + "description": "names of the ssh key pairs used to login to the virtual machine", "length": 255, - "name": "backupid", - "related": "", - "required": true, - "type": "uuid" + "name": "keypairs", + "required": false, + "since": "4.17", + "type": "list" }, { - "description": "Details in key/value pairs using format externaldetails[i].keyname=keyvalue. Example: externaldetails[0].server.type=typevalue", + "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": "externaldetails", + "name": "securitygroupids", + "related": "updateSecurityGroup", "required": false, - "since": "4.21.0", - "type": "map" + "type": "list" }, { - "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": "true if start vm after creating; defaulted to true if not specified", "length": 255, - "name": "datadiskofferinglist", - "required": false, - "since": "4.11", - "type": "map" + "name": "startvm", + "required": false, + "type": "boolean" }, { - "description": "an optional field, whether to the display the vm to the end user or not.", + "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": "displayvm", + "name": "preserveip", "required": false, - "since": "4.2", "type": "boolean" }, { - "description": "Boot Mode [Legacy] or [Secure] Applicable when Boot Type Selected is UEFI, otherwise Legacy only for BIOS. Not applicable with VMware if the template is marked as deploy-as-is, as we honour what is defined in the template.", + "description": "an optional user generated name for the virtual machine", "length": 255, - "name": "bootmode", + "name": "displayname", "required": false, - "since": "4.14.0.0", "type": "string" }, { - "description": "availability zone for the virtual machine", + "description": "the ip address for default vm's network", "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, - "type": "uuid" + "name": "ipaddress", + "required": false, + "type": "string" }, { - "description": "comma separated list of affinity groups names that are going to be applied to the virtual machine.Mutually exclusive with affinitygroupids parameter", + "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": "affinitygroupnames", - "related": "createAffinityGroup,listAffinityGroups", + "name": "iothreadsenabled", "required": false, - "type": "list" + "type": "boolean" }, { - "description": "the hypervisor on which to deploy the virtual machine. The parameter is required and respected only when hypervisor info is not set on the ISO/Template passed to the call", + "description": "an optional group for the virtual machine", "length": 255, - "name": "hypervisor", + "name": "group", "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": "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": "customid", + "name": "iptonetworklist", + "required": false, + "type": "map" + }, + { + "description": "Guest VM Boot option either custom[UEFI] or default boot [BIOS]. Not applicable with VMware if the template is marked as deploy-as-is, as we honour what is defined in the template.", + "length": 255, + "name": "boottype", "required": false, + "since": "4.14.0.0", "type": "string" }, { - "description": "used to specify the vApp properties.", + "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": "properties", + "name": "nicnetworklist", "required": false, "since": "4.15", "type": "map" }, { - "description": "an optional account for the virtual machine. Must be used with domainId.", + "description": "backup ID to create the VM from", "length": 255, - "name": "account", - "required": false, - "type": "string" + "name": "backupid", + "related": "", + "required": true, + "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.", + "description": "destination Pod ID to deploy the VM to - parameter available for root admin only", "length": 255, - "name": "boottype", + "name": "podid", + "related": "createPod,listPods,createManagementNetworkIpRange", "required": false, - "since": "4.14.0.0", - "type": "string" + "since": "4.21", + "type": "uuid" }, { - "description": "used to specify the parameters values for the variables in userdata.", + "description": "Disk offering details for creating multiple data volumes. Mutually exclusive with diskOfferingId. Example: datadisksdetails[0].diskofferingid=a2a73a84-19db-4852-8930-dfddef053341&datadisksdetails[0].size=10&datadisksdetails[0].miniops=100&datadisksdetails[0].maxiops=200", "length": 255, - "name": "userdatadetails", + "name": "datadisksdetails", "required": false, - "since": "4.18", + "since": "4.21.0", "type": "map" }, { - "description": "true if virtual machine needs to be dynamically scalable", + "description": "destination Cluster ID to deploy the VM to - parameter available for root admin only", "length": 255, - "name": "dynamicscalingenabled", + "name": "clusterid", + "related": "addCluster,updateCluster", "required": false, - "since": "4.16", - "type": "boolean" + "since": "4.21", + "type": "uuid" }, { - "description": "an optional group 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": "group", + "name": "hypervisor", "required": false, "type": "string" }, { - "description": "destination Host ID to deploy the VM to - parameter available for root admin only", + "description": "list of network ids used by virtual machine. Can't be specified with ipToNetworkList parameter", "length": 255, - "name": "hostid", - "related": "declareHostAsDegraded,listHosts,reconnectHost", + "name": "networkids", + "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", "required": false, - "type": "uuid" + "type": "list" }, { "description": "Deployment planner to use for vm allocation. Available to ROOT admin only", @@ -78625,233 +78935,256 @@ "type": "string" }, { - "description": "true if start vm after creating; defaulted to true if not specified", + "description": "Deploy vm for the project", "length": 255, - "name": "startvm", + "name": "projectid", + "related": "createProject", "required": false, - "type": "boolean" + "type": "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.", + "description": "Number of days instance is leased for.", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains,moveDomain", + "name": "leaseduration", "required": false, - "type": "uuid" + "since": "4.21.0", + "type": "integer" }, { - "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.", + "description": "the arbitrary size for the DATADISK volume. Mutually exclusive with diskOfferingId", "length": 255, - "name": "preserveip", + "name": "size", "required": false, - "type": "boolean" + "type": "long" }, { - "description": "the ID of the Userdata", + "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": "userdataid", - "related": "listCniConfiguration", + "name": "datadiskofferinglist", "required": false, - "since": "4.18", - "type": "uuid" + "since": "4.11", + "type": "map" }, { - "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": "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": "dhcpoptionsnetworklist", + "name": "domainid", + "related": "createDomain,listDomains,listDomains,moveDomain", "required": false, - "type": "map" + "type": "uuid" }, { - "description": "Lease expiry action, valid values are STOP and DESTROY", + "description": "the ID of the service offering for the virtual machine", "length": 255, - "name": "leaseexpiryaction", + "name": "serviceofferingid", + "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", "required": false, - "since": "4.21.0", - "type": "string" + "type": "uuid" }, { - "description": "Number of days instance is leased for.", + "description": "the ID of the template for the virtual machine", "length": 255, - "name": "leaseduration", + "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.21.0", - "type": "integer" + "type": "uuid" }, { - "description": "the ipv6 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": "ip6address", + "name": "diskofferingid", + "related": "", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "used to specify the custom parameters. 'extraconfig' is not allowed to be passed in details", + "description": "availability zone for the virtual machine", "length": 255, - "name": "details", + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" + }, + { + "description": "an optional keyboard device type for the virtual machine. valid value can be one of de,de-ch,es,fi,fr,fr-be,fr-ch,is,it,jp,nl-be,no,pt,uk,us", + "length": 255, + "name": "keyboard", "required": false, - "since": "4.3", - "type": "map" + "type": "string" }, { - "description": "names of the ssh key pairs used to login to the virtual machine", + "description": "Enable packed virtqueues or not.", "length": 255, - "name": "keypairs", + "name": "nicpackedvirtqueuesenabled", "required": false, - "since": "4.17", - "type": "list" + "since": "4.18", + "type": "boolean" }, { - "description": "list of network ids used by virtual machine. Can't be specified with ipToNetworkList parameter", + "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": "networkids", - "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", + "name": "affinitygroupids", + "related": "createAffinityGroup,listAffinityGroups", "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", + "description": "Boot into hardware setup or not (ignored if startVm = false, only valid for vmware)", "length": 255, - "name": "iptonetworklist", + "name": "bootintosetup", "required": false, - "type": "map" + "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": "true if virtual machine needs to be dynamically scalable", "length": 255, - "name": "nicnetworklist", + "name": "dynamicscalingenabled", "required": false, - "since": "4.15", - "type": "map" + "since": "4.16", + "type": "boolean" }, { - "description": "The password of the virtual machine. If null, a random password will be generated for the VM.", + "description": "Controls specific policies on IO", "length": 255, - "name": "password", + "name": "iodriverpolicy", "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": "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": "rootdisksize", + "name": "securitygroupnames", + "related": "updateSecurityGroup", "required": false, - "since": "4.4", - "type": "long" + "type": "list" }, { - "description": "the ID of the disk offering for the virtual machine. If the template is of ISO format, the diskOfferingId is for the root disk volume. Otherwise this parameter is used to indicate the offering for the data disk volume. If the templateId parameter passed is from a Template object, the diskOfferingId refers to a DATA Disk Volume created. If the templateId parameter passed is from an ISO object, the diskOfferingId refers to a ROOT Disk Volume created.", + "description": "the ID of the disk offering for the virtual machine to be used for root volume instead of the disk offering mapped in service offering.In case of virtual machine deploying from ISO, then the diskofferingid specified for root volume is ignored and uses this override disk offering id", "length": 255, - "name": "diskofferingid", + "name": "overridediskofferingid", "related": "", "required": false, + "since": "4.17", "type": "uuid" }, { - "description": "name of the ssh key pair used to login to the virtual machine", + "description": "The password of the virtual machine. If null, a random password will be generated for the VM.", "length": 255, - "name": "keypair", + "name": "password", "required": false, + "since": "4.19.0.0", "type": "string" }, { - "description": "the ID of the disk offering for the virtual machine to be used for root volume instead of the disk offering mapped in service offering.In case of virtual machine deploying from ISO, then the diskofferingid specified for root volume is ignored and uses this override disk offering id", + "description": "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": "overridediskofferingid", - "related": "", + "name": "affinitygroupnames", + "related": "createAffinityGroup,listAffinityGroups", "required": false, - "since": "4.17", - "type": "uuid" + "type": "list" }, { - "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": "used to specify the vApp properties.", "length": 255, - "name": "securitygroupids", - "related": "updateSecurityGroup", + "name": "properties", "required": false, - "type": "list" + "since": "4.15", + "type": "map" }, { - "description": "destination Cluster ID to deploy the VM to - parameter available for root admin only", + "description": "used to specify the custom parameters. 'extraconfig' is not allowed to be passed in details", "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", + "name": "details", "required": false, - "since": "4.21", - "type": "uuid" + "since": "4.3", + "type": "map" }, { - "description": "the mac address for default vm's network", + "description": "The number of queues for multiqueue NICs.", "length": 255, - "name": "macaddress", + "name": "nicmultiqueuenumber", + "required": false, + "since": "4.18", + "type": "integer" + }, + { + "description": "an optional account for the virtual machine. Must be used with domainId.", + "length": 255, + "name": "account", "required": false, "type": "string" }, { - "description": "Controls specific policies on IO", + "description": "Lease expiry action, valid values are STOP and DESTROY", "length": 255, - "name": "iodriverpolicy", + "name": "leaseexpiryaction", "required": false, + "since": "4.21.0", "type": "string" }, { - "description": "Enable packed virtqueues or not.", + "description": "used to specify the parameters values for the variables in userdata.", "length": 255, - "name": "nicpackedvirtqueuesenabled", + "name": "userdatadetails", "required": false, "since": "4.18", - "type": "boolean" + "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 ID of the Userdata", "length": 255, - "name": "keyboard", + "name": "userdataid", + "related": "listCniConfiguration", "required": false, - "type": "string" + "since": "4.18", + "type": "uuid" }, { - "description": "if true the image tags (if any) will be copied to the VM, default value is false", + "description": "Details in key/value pairs using format externaldetails[i].keyname=keyvalue. Example: externaldetails[0].server.type=typevalue", "length": 255, - "name": "copyimagetags", + "name": "externaldetails", "required": false, - "since": "4.13", - "type": "boolean" + "since": "4.21.0", + "type": "map" }, { - "description": "an optional binary data that can be sent to the virtual machine upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST (via POST body), you can send up to 1MB of data after base64 encoding. You also need to change vm.userdata.max.length value", - "length": 1048576, - "name": "userdata", + "description": "the mac address for default vm's network", + "length": 255, + "name": "macaddress", + "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" } ], - "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", + "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,createVMFromBackup,assignVirtualMachine,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "response": [ { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", - "type": "string" - }, - { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "the ID of the vgpu profile to which service offering is linked", - "name": "vgpuprofileid", - "type": "string" + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "the name of the vgpu profile to which service offering is linked", - "name": "vgpuprofilename", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", - "type": "string" + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" }, { "description": "the count of GPUs on the virtual machine", @@ -78859,20 +79192,30 @@ "type": "integer" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "Base64 string containing the user data", + "name": "userdata", "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 control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "the ID of the host for the virtual machine", + "name": "hostid", + "type": "string" + }, + { + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", "type": "string" }, + { + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" + }, { "description": "device type of the root volume", "name": "rootdevicetype", @@ -78883,628 +79226,494 @@ "name": "domain", "type": "string" }, + { + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, { "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", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" + }, + { + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", + "type": "string" + }, + { + "description": "the list of resource tags associated", + "name": "tags", "response": [ { - "description": "the name of the affinity group", - "name": "name", - "type": "string" - }, - { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project name of the affinity group", + "description": "the project name where tag belongs to", "name": "project", "type": "string" }, { - "description": "the domain ID of the affinity group", + "description": "the ID of the domain associated with the tag", "name": "domainid", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" }, { - "description": "the ID of the affinity group", - "name": "id", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", - "type": "list" + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" }, { - "description": "the account owning the affinity group", - "name": "account", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" } ], "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", + "description": "the list of nics associated with vm", + "name": "nic", "response": [ { - "description": "tag key name", - "name": "key", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "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": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the netmask of the nic", + "name": "netmask", "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": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "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": "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 isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "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": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "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": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "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", + "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 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", - "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", + "description": "the speed of each vCPU", + "name": "cpuspeed", "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": "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 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 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 project name of the affinity group", + "name": "project", + "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" + }, + { + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + } + ], + "type": "set" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "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": "true if vm has delete protection.", - "name": "deleteprotection", - "type": "boolean" - }, - { - "description": "Os type ID of the virtual machine", - "name": "guestosid", - "type": "string" + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, { "description": "list of security groups associated with the virtual machine", "name": "securitygroup", "response": [ { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", + "description": "the description of the security group", + "name": "description", + "type": "string" + }, + { + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the ID of the security group", + "name": "id", + "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 name of the security group", "name": "name", "type": "string" }, { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", + "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 ending IP of the security group rule ", - "name": "endport", - "type": "integer" + "description": "id of the resource", + "name": "resourceid", + "type": "string" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "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": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "set" + }, + { + "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 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", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -79513,28 +79722,33 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "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": "the account associated with the tag", - "name": "account", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { @@ -79548,26 +79762,21 @@ "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", + "description": "tag key name", + "name": "key", "type": "string" } ], "type": "set" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "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" }, { @@ -79576,103 +79785,31 @@ "type": "integer" }, { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" }, { "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", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "security group name", + "name": "securitygroupname", "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", + "description": "path of the Domain the security group belongs to", + "name": "domainpath", "type": "string" }, { @@ -79680,39 +79817,19 @@ "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": "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 code for the ICMP message response", + "name": "icmpcode", + "type": "integer" }, { "description": "the CIDR notation for the base IP address of the security group rule", @@ -79730,86 +79847,86 @@ "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": "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" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "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": "tag value", + "name": "value", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag key name", + "name": "key", "type": "string" } ], "type": "set" }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, { "description": "the type of the ICMP message response", "name": "icmptype", "type": "integer" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" } ], "type": "set" @@ -79817,298 +79934,396 @@ ], "type": "set" }, + { + "description": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" + }, + { + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, { "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": "OS name of the vm", + "name": "osdisplayname", + "type": "string" + }, { - "description": "Name of the schedule", - "length": 255, - "name": "description", - "required": false, + "description": "the group ID of the virtual machine", + "name": "groupid", "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": "the maximum X resolution", + "name": "maxresolutionx", + "type": "long" }, { - "description": "start date from which the schedule becomes activeUse format \"yyyy-MM-dd hh:mm:ss\")", - "length": 255, - "name": "startdate", - "required": false, - "type": "date" + "description": "the project id of the vm", + "name": "projectid", + "type": "string" }, { - "description": "ID of VM schedule", - "length": 255, - "name": "id", - "related": "updateVMSchedule", - "required": true, - "type": "uuid" + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" }, { - "description": "Specifies a timezone for this command. For more information on the timezone parameter, see TimeZone Format.", - "length": 255, - "name": "timezone", - "required": false, + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "Enable VM schedule", - "length": 255, - "name": "enabled", - "required": false, - "type": "boolean" + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { - "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, + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" - } - ], - "related": "", - "response": [ + }, { - "description": "Date when the schedule was created", - "name": "created", - "type": "date" + "description": "the user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" }, { - "description": "the ID of VM schedule", - "name": "id", + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "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": "VM schedule is enabled", - "name": "enabled", - "type": "boolean" + "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", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "Action", - "name": "action", - "type": "action" + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" }, { - "description": "Date from which the schedule is active", - "name": "startdate", - "type": "date" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "Cron formatted VM schedule", - "name": "schedule", + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "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": "Timezone of the schedule", - "name": "timezone", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { - "description": "Date after which the schedule becomes inactive", - "name": "enddate", - "type": "date" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "Description of VM schedule", - "name": "description", + "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": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + { + "description": "the user's name who deployed the virtual machine", + "name": "username", + "type": "string" + }, + { + "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 outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", + "type": "string" + }, + { + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "Guest vm Boot Type", + "name": "boottype", + "type": "string" + }, + { + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", + "type": "string" + }, + { + "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 id of userdata used for the VM", + "name": "userdataid", + "type": "string" + }, + { + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" + }, + { + "description": "the account associated with the virtual machine", + "name": "account", + "type": "string" + }, + { + "description": "the name of userdata used for the VM", + "name": "userdataname", + "type": "string" + }, + { + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "the format of the template for the virtual machine", + "name": "templateformat", + "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 type of the template for the virtual machine", + "name": "templatetype", + "type": "string" + }, + { + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "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", + "type": "long" + }, + { + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "the pool type of the virtual machine", + "name": "pooltype", + "type": "string" + }, + { + "description": "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 VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "OS type id of the vm", + "name": "ostypeid", + "type": "string" + }, + {}, + { + "description": "the video RAM size in MB", + "name": "videoram", + "type": "long" + }, + { + "description": "the VM's primary IP address", + "name": "ipaddress", + "type": "string" + }, + { + "description": "CPU arch of the VM", + "name": "arch", + "type": "string" + }, + { + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" + }, + { + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", + "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 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": "ID of virtual machine", - "name": "virtualmachineid", + "description": "User VM type", + "name": "vmtype", + "type": "string" + }, + { + "description": "the group name of the virtual machine", + "name": "group", + "type": "string" + }, + { + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", + "type": "string" + }, + { + "description": "the state of the virtual machine", + "name": "state", + "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 maximum number of display heads", + "name": "maxheads", + "type": "long" + }, + { + "description": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" + }, + { + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" + }, + { + "description": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" + }, + { + "description": "the name of the virtual machine", + "name": "name", "type": "string" } ], - "since": "4.19.0" + "since": "4.21.0" }, { "description": "Lists all configuration groups (primarily used for UI).", @@ -80116,16 +80331,16 @@ "name": "listConfigurationGroups", "params": [ { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "lists configuration group by group name", + "description": "List by keyword", "length": 255, - "name": "group", + "name": "keyword", "required": false, "type": "string" }, @@ -80137,58 +80352,58 @@ "type": "integer" }, { - "description": "", + "description": "lists configuration group by group name", "length": 255, - "name": "pagesize", + "name": "group", "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 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" + }, + { + "description": "the name of the configuration subgroup", + "name": "name", + "type": "string" } ], "type": "list" }, + { + "description": "the precedence of the configuration group", + "name": "precedence", + "type": "long" + }, + {}, + { + "description": "the name of the configuration group", + "name": "name", + "type": "string" + }, + {}, + { + "description": "the description of the configuration group", + "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" } ], "since": "4.18.0" @@ -80207,11 +80422,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", @@ -80222,13 +80433,17 @@ "name": "displaytext", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, - {}, - {} + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } ] }, { @@ -80236,14 +80451,6 @@ "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, @@ -80259,43 +80466,42 @@ "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": "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", + "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", + "description": "the range of ips to allocate to the clients", + "name": "iprange", "type": "string" }, + {}, { "description": "the project name of the vpn", "name": "project", "type": "string" }, { - "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" + "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", + "description": "the ipsec preshared key", + "name": "presharedkey", "type": "string" }, { @@ -80304,40 +80510,49 @@ "type": "string" }, { - "description": "the public ip address of the vpn server", - "name": "publicipid", + "description": "the state of the rule", + "name": "state", "type": "string" }, { - "description": "is vpn for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the account of the remote access vpn", + "name": "account", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "path of the domain to which the remote access vpn belongs", + "name": "domainpath", "type": "string" }, - {}, - {}, { - "description": "the range of ips to allocate to the clients", - "name": "iprange", + "description": "the domain id of the account of the remote access vpn", + "name": "domainid", "type": "string" }, { - "description": "the public ip address of the vpn server", - "name": "publicip", + "description": "the domain name of the account of the remote access vpn", + "name": "domain", "type": "string" }, { - "description": "the ipsec preshared key", - "name": "presharedkey", + "description": "the id of the remote access vpn", + "name": "id", "type": "string" }, { - "description": "the state of the rule", - "name": "state", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the public ip address of the vpn server", + "name": "publicipid", "type": "string" } ], @@ -80352,15 +80567,15 @@ "description": "the virtual machine ID to which the GPU device is allocated", "length": 255, "name": "virtualmachineid", - "related": "assignVirtualMachine,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm", + "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,createVMFromBackup,assignVirtualMachine,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "required": false, "type": "uuid" }, { - "description": "the host ID where the GPU device is attached", + "description": "ID of the GPU device", "length": 255, - "name": "hostid", - "related": "declareHostAsDegraded,listHosts,reconnectHost", + "name": "id", + "related": "listGpuDevices,listGpuDevices,discoverGpuDevices,createGpuDevice", "required": false, "type": "uuid" }, @@ -80372,40 +80587,40 @@ "type": "integer" }, { - "description": "the vGPU profile ID assigned to the GPU device", + "description": "List by keyword", "length": 255, - "name": "vgpuprofileid", - "related": "createVgpuProfile,updateVgpuProfile", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "", + "description": "the GPU card ID associated with the GPU device", "length": 255, - "name": "pagesize", + "name": "gpucardid", + "related": "listGpuCards", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "the GPU card ID associated with the GPU device", + "description": "the host ID where the GPU device is attached", "length": 255, - "name": "gpucardid", - "related": "listGpuCards", + "name": "hostid", + "related": "declareHostAsDegraded,listHosts,reconnectHost", "required": false, "type": "uuid" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "ID of the GPU device", + "description": "the vGPU profile ID assigned to the GPU device", "length": 255, - "name": "id", - "related": "listGpuDevices,listGpuDevices,discoverGpuDevices,createGpuDevice", + "name": "vgpuprofileid", + "related": "createVgpuProfile,updateVgpuProfile", "required": false, "type": "uuid" } @@ -80413,29 +80628,33 @@ "related": "listGpuDevices,discoverGpuDevices,createGpuDevice", "response": [ { - "description": "the host ID where the GPU device is attached", - "name": "hostid", - "type": "string" + "description": "bus address of the GPU device", + "name": "gpudevicetype", + "type": "devicetype" }, { - "description": "bus address of the GPU device or MDEV UUID for vGPU devices", - "name": "busaddress", - "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": "state", "type": "state" }, { - "description": "the vGPU profile name assigned to this GPU device", - "name": "virtualmachinename", + "description": "the vGPU profile ID assigned to this GPU device", + "name": "virtualmachineid", "type": "string" }, { - "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 GPU card ID associated with this GPU device", + "name": "gpucardid", "type": "string" }, { @@ -80443,65 +80662,61 @@ "name": "vgpuprofilename", "type": "string" }, + {}, { - "description": "bus address of the GPU device", - "name": "gpudevicetype", - "type": "devicetype" + "description": "bus address of the GPU device or MDEV UUID for vGPU devices", + "name": "busaddress", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + { + "description": "the GPU card name associated with this GPU device", + "name": "gpucardname", + "type": "string" + }, { "description": "the vGPU profile ID assigned to this GPU device", - "name": "virtualmachineid", + "name": "vgpuprofileid", "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": "virtualmachinename", + "type": "string" }, { "description": "the managed state of the GPU device (Enabled/Disabled)", "name": "managedstate", "type": "managedstate" }, - { - "description": "the vGPU profile ID assigned to this GPU device", - "name": "vgpuprofileid", - "type": "string" - }, {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "the ID of the GPU device", "name": "id", "type": "string" }, { - "description": "the GPU card ID associated with this GPU device", - "name": "gpucardid", + "description": "the host name where the GPU device is attached", + "name": "hostname", "type": "string" }, { - "description": "the NUMA node where the GPU device is located", - "name": "numanode", + "description": "the ID of the parent GPU device, if this is a vGPU", + "name": "parentgpudeviceid", "type": "string" }, { - "description": "the GPU card name associated with this GPU device", - "name": "gpucardname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the host name where the GPU device is attached", - "name": "hostname", + "description": "the host ID where the GPU device is attached", + "name": "hostid", "type": "string" } ], @@ -80520,49 +80735,163 @@ "since": "4.2.1", "type": "boolean" }, + { + "description": "The ID of the virtual machine", + "length": 255, + "name": "id", + "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,createVMFromBackup,assignVirtualMachine,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "required": true, + "type": "uuid" + }, { "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", + "related": "importVolume,createVolume,updateVolume,listVolumes,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", "required": false, "since": "4.12.0", "type": "list" - }, - { - "description": "The ID of the virtual machine", - "length": 255, - "name": "id", - "related": "assignVirtualMachine,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm", - "required": true, - "type": "uuid" } ], - "related": "assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm", + "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,createVMFromBackup,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "response": [ + { + "description": "OS type id of the vm", + "name": "ostypeid", + "type": "string" + }, + { + "description": "User VM type", + "name": "vmtype", + "type": "string" + }, + { + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", + "type": "string" + }, + { + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" + }, + { + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "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 virtual machine", + "name": "id", + "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 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 vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" + }, + { + "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 domain in which the virtual machine exists", + "name": "domainid", + "type": "string" + }, + { + "description": "the ID of the host for the virtual machine", + "name": "hostid", + "type": "string" + }, { "description": "the maximum Y resolution", "name": "maxresolutiony", "type": "long" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "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 service offering of the virtual machine", + "name": "serviceofferingname", "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": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the maximum X resolution", + "name": "maxresolutionx", + "type": "long" + }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -80571,18 +80900,18 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -80591,46 +80920,76 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "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": "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" } ], "type": "set" }, { - "description": "true if vm has delete protection.", - "name": "deleteprotection", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", + "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 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": "true if the entity/resource has annotations", + "name": "hasannotations", "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 UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "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" }, { @@ -80639,52 +80998,68 @@ "type": "integer" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "the state of the virtual machine", + "name": "state", "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 state of the virtual machine", - "name": "state", - "type": "string" + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "the ID of the gpu card to which service offering is linked", - "name": "gpucardid", + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "Guest vm Boot Type", + "name": "boottype", "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", + "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 account owning the security group", - "name": "account", + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "the project name of the group", + "name": "project", "type": "string" }, { @@ -80693,66 +81068,36 @@ "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 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": "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": "security group name", - "name": "securitygroupname", - "type": "string" - }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "resource type", - "name": "resourcetype", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "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" }, { @@ -80761,56 +81106,91 @@ "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 name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "tag value", + "name": "value", "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 project id the tag belongs to", - "name": "projectid", + "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", "type": "string" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", + "description": "the ending IP of the security group rule ", + "name": "endport", "type": "integer" }, { "description": "the 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 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" } ], "type": "set" }, + { + "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", @@ -80821,8 +81201,13 @@ "type": "string" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", "type": "integer" }, { @@ -80830,8 +81215,8 @@ "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -80840,33 +81225,38 @@ "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": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "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": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -80878,11 +81268,6 @@ "description": "the project name where tag belongs to", "name": "project", "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" } ], "type": "set" @@ -80893,9 +81278,9 @@ "type": "integer" }, { - "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", @@ -80903,31 +81288,26 @@ "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", + "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 description of the security group", - "name": "description", + "description": "the account owning the security group", + "name": "account", "type": "string" }, { @@ -80936,20 +81316,15 @@ "type": "string" }, { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" + "description": "path of the Domain the security group belongs to", + "name": "domainpath", + "type": "string" }, { "description": "the 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", @@ -80960,550 +81335,286 @@ "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": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "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": "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 name where tag belongs to", - "name": "project", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the project name where tag belongs to", + "name": "project", "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", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, - { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "description": "the 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", + "description": "the VM's primary IP address", + "name": "ipaddress", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the project name of the vm", - "name": "project", + "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": "the read (IO) of disk on the VM", - "name": "diskioread", + "description": "the maximum number of display heads", + "name": "maxheads", "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 description of the affinity group", - "name": "description", - "type": "string" - }, - { - "description": "the account owning the affinity group", - "name": "account", + "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 name of the affinity group", - "name": "name", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "the type of the affinity group", + "description": "the type of the nic", "name": "type", "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" - } - ], - "type": "set" - }, - { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", - "type": "string" - }, - { - "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": "the ID of the availability zone for the virtual machine", - "name": "zoneid", - "type": "string" - }, - { - "description": "Os type ID of the virtual machine", - "name": "guestosid", - "type": "string" - }, - { - "description": "the group name of the virtual machine", - "name": "group", - "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 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 ID of the host for the virtual machine", - "name": "hostid", - "type": "string" - }, - { - "description": "the count of GPUs on the virtual machine", - "name": "gpucount", - "type": "integer" - }, - { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "CPU arch of the VM", - "name": "arch", - "type": "string" - }, - { - "description": "Instance lease expiry date", - "name": "leaseexpirydate", - "type": "date" - }, - {}, - { - "description": "the list of nics associated with vm", - "name": "nic", - "response": [ - { - "description": "the 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": "macaddress", - "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" }, { - "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 ID of the corresponding network", - "name": "networkid", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" }, { - "description": "the type of the nic", - "name": "type", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "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": "the isolation uri of the nic", - "name": "isolationuri", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "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": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, { "description": "the isolated private VLAN if available", "name": "isolatedpvlan", "type": "integer" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "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": "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": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" }, { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the ip address of the nic", + "name": "ipaddress", "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": "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": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "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 Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" } ], "type": "set" }, - {}, - { - "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 memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" - }, - { - "description": "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 incoming network traffic on the VM in KiB", - "name": "networkkbsread", + "description": "the read (IO) of disk on the VM", + "name": "diskioread", "type": "long" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", + "description": "device ID of the root volume", + "name": "rootdeviceid", "type": "long" }, { @@ -81511,19 +81622,14 @@ "name": "userdatapolicy", "type": "string" }, - { - "description": "the name of userdata used for the VM", - "name": "userdataname", - "type": "string" - }, { "description": "the ID of the vgpu profile to which service offering is linked", "name": "vgpuprofileid", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { @@ -81531,19 +81637,54 @@ "name": "publicipid", "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 type of the template for the virtual machine", + "name": "templatetype", + "type": "string" + }, { "description": "the pool type of the virtual machine", "name": "pooltype", "type": "string" }, { - "description": "Instance lease expiry action", - "name": "leaseexpiryaction", + "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": "User VM type", - "name": "vmtype", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "the name of userdata used for the VM", + "name": "userdataname", + "type": "string" + }, + { + "description": " 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" }, { @@ -81552,73 +81693,83 @@ "type": "string" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "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 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 userdata used for the VM", + "name": "userdataid", + "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "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", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, + { + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" + }, + { + "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": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", + "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "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 memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" }, { - "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" }, { @@ -81627,74 +81778,138 @@ "type": "string" }, { - "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", + "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 ID of the affinity group", + "name": "projectid", + "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 type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + }, + { + "description": "the 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" + } + ], + "type": "set" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "type": "string" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "description": "the maximum X resolution", - "name": "maxresolutionx", - "type": "long" + "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": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", + "description": "the 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 hypervisor on which the template runs", - "name": "hypervisor", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" }, + {}, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "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": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" - }, - { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", + "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": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "the user's name who deployed the virtual machine", + "name": "username", + "type": "string" } ] }, @@ -81704,24 +81919,34 @@ "name": "assignVirtualMachineToBackupOffering", "params": [ { - "description": "ID of the backup offering", + "description": "ID of the virtual machine", "length": 255, - "name": "backupofferingid", - "related": "listBackupOfferings,updateBackupOffering", + "name": "virtualmachineid", + "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,createVMFromBackup,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "required": true, "type": "uuid" }, { - "description": "ID of the virtual machine", + "description": "ID of the backup offering", "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", + "name": "backupofferingid", + "related": "listBackupOfferings,updateBackupOffering", "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", @@ -81732,17 +81957,7 @@ "name": "displaytext", "type": "string" }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } + {} ], "since": "4.14.0" }, @@ -81771,16 +81986,16 @@ "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,createVMFromBackup,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "required": true, "type": "uuid" }, { - "description": "Boot into hardware setup menu or not", + "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": "bootintosetup", + "name": "considerlasthost", "required": false, - "since": "4.15.0.0", + "since": "4.18.0", "type": "boolean" }, { @@ -81801,25 +82016,20 @@ "type": "string" }, { - "description": "True by default, CloudStack will firstly try to start the VM on the last host where it run on before stopping, if destination host is not specified. If false, CloudStack will not consider the last host and start the VM by normal process.", + "description": "Boot into hardware setup menu or not", "length": 255, - "name": "considerlasthost", + "name": "bootintosetup", "required": false, - "since": "4.18.0", + "since": "4.15.0.0", "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", + "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,createVMFromBackup,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "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 ID of the host for the virtual machine", - "name": "hostid", - "type": "string" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { "description": "State of the Service from LB rule", @@ -81827,99 +82037,84 @@ "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": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the state of the virtual machine", - "name": "state", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", "type": "string" }, + {}, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", + "description": "true if vm has delete protection.", + "name": "deleteprotection", "type": "boolean" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, - {}, { - "description": "Instance lease duration in days", - "name": "leaseduration", - "type": "integer" + "description": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", - "type": "string" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", - "type": "string" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "User VM type", - "name": "vmtype", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "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 ID of the gpu card to which service offering is linked", + "name": "gpucardid", "type": "string" }, { @@ -81928,356 +82123,58 @@ "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": "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": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "CPU arch of the VM", + "name": "arch", "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "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 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", + "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 number of vCPUs this virtual machine is using", - "name": "cpunumber", + "description": "the count of GPUs on the virtual machine", + "name": "gpucount", "type": "integer" }, - { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", - "type": "string" - }, - { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, { "description": "the memory allocated for the virtual machine", "name": "memory", "type": "integer" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" - }, - { - "description": "the name of the gpu card to which service offering is linked", - "name": "gpucardname", - "type": "string" - }, - { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", - "type": "string" - }, - { - "description": "Instance lease expiry date", - "name": "leaseexpirydate", - "type": "date" - }, - { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "the format of the template for the virtual machine", - "name": "templateformat", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, - { - "description": "the video RAM size in MB", - "name": "videoram", - "type": "long" - }, { "description": "the ID of the virtual machine", "name": "id", "type": "string" }, { - "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": "the ID of the domain in which the virtual machine exists", - "name": "domainid", - "type": "string" - }, - { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" - }, - { - "description": "the maximum Y resolution", - "name": "maxresolutiony", - "type": "long" - }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, - { - "description": "the maximum X resolution", - "name": "maxresolutionx", - "type": "long" - }, - { - "description": "the list of nics associated with vm", - "name": "nic", - "response": [ - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "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": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - } - ], - "type": "set" - }, - {}, - { - "description": "the 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": "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": "VNF details", - "name": "vnfdetails", - "type": "map" - }, - { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "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": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "Instance lease expiry action", - "name": "leaseexpiryaction", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { @@ -82286,188 +82183,76 @@ "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", - "type": "string" - }, - { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", - "type": "string" - }, - { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" - }, - { - "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 incoming network traffic on the VM in KiB", - "name": "networkkbsread", + "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", + "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": "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 VM's primary IP address", + "name": "ipaddress", "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "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 VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, { "description": "the VM's disk read in KiB", "name": "diskkbsread", "type": "long" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", - "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", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the name of the host for the virtual machine", + "name": "hostname", "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", - "type": "string" - }, - { - "description": "the project name of the affinity group", - "name": "project", - "type": "string" - }, - { - "description": "the description of the affinity group", - "name": "description", - "type": "string" - }, - { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "description": "the ID of the affinity group", - "name": "id", - "type": "string" - }, - { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", - "type": "list" - }, - { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" - }, - { - "description": "the type of the affinity group", - "name": "type", - "type": "string" - }, - { - "description": "the project ID of the affinity group", - "name": "projectid", - "type": "string" - }, - { - "description": "the name of the affinity group", - "name": "name", - "type": "string" - }, - { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" - }, - { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", - "type": "string" - } - ], - "type": "set" + "description": "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 project id of the group", - "name": "projectid", + "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 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": "resource type", - "name": "resourcetype", + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -82481,23 +82266,18 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -82506,26 +82286,51 @@ "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" } ], "type": "set" }, { - "description": "the name of the security group", - "name": "name", + "description": "the project name of the group", + "name": "project", "type": "string" }, { - "description": "the description of the security group", - "name": "description", + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "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 account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "the domain name of the security group", + "name": "domain", "type": "string" }, { @@ -82533,8 +82338,8 @@ "name": "ingressrule", "response": [ { - "description": "the starting IP of the security group rule", - "name": "startport", + "description": "the code for the ICMP message response", + "name": "icmpcode", "type": "integer" }, { @@ -82542,14 +82347,24 @@ "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": "security group name", "name": "securitygroupname", "type": "string" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "account owning the security group rule", + "name": "account", "type": "string" }, { @@ -82558,22 +82373,27 @@ "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 protocol of the security group rule", + "name": "protocol", + "type": "string" }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "the 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": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -82582,33 +82402,33 @@ "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": "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": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -82617,72 +82437,67 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag key name", + "name": "key", "type": "string" } ], "type": "set" - }, - { - "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" } ], "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 egress rules associated with the security group", "name": "egressrule", "response": [ + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, { "description": "the type of the ICMP message response", "name": "icmptype", "type": "integer" }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the 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": "customer associated with the tag", - "name": "customer", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -82691,33 +82506,33 @@ "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": "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": "id of the resource", - "name": "resourceid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -82728,218 +82543,515 @@ ], "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", + "description": "the code for the ICMP message response", + "name": "icmpcode", "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", - "type": "integer" } ], "type": "set" }, { - "description": "the project name of the group", - "name": "project", + "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 number of virtualmachines associated with this securitygroup", "name": "virtualmachinecount", "type": "integer" + } + ], + "type": "set" + }, + { + "description": "Instance lease duration in days", + "name": "leaseduration", + "type": "integer" + }, + { + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "resource type", + "name": "resourcetype", + "type": "string" }, { - "description": "the account owning the security group", + "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": "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": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" } ], "type": "set" }, { - "description": "CPU arch of the VM", - "name": "arch", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the maximum number of display heads", - "name": "maxheads", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" + }, + { + "description": "Base64 string containing the user data", + "name": "userdata", + "type": "string" + }, + { + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", "type": "long" }, { - "description": "the count of GPUs on the virtual machine", - "name": "gpucount", + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the project name of the vm", + "name": "project", + "type": "string" + }, + { + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + { + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" + }, + { + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" + }, + { + "description": "Guest vm Boot Mode", + "name": "bootmode", + "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 UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the name of userdata used for the VM", + "name": "userdataname", + "type": "string" + }, + {}, + { + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, + { + "description": "the user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" + }, + { + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "type": "string" + }, + { + "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", + "type": "string" + }, + { + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" + }, + { + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, + { + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" + }, + { + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, + { + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", + "type": "string" + }, + { + "description": "the state of the virtual machine", + "name": "state", + "type": "string" + }, + { + "description": "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": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", + "description": "the maximum Y resolution", + "name": "maxresolutiony", + "type": "long" + }, + { + "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", + "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": "the list of nics associated with vm", + "name": "nic", "response": [ { - "description": "id of the resource", - "name": "resourceid", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "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": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "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 account associated with the tag", - "name": "account", + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "the ID of the nic", + "name": "id", + "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 name of the corresponding network", + "name": "networkname", + "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": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "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": "the netmask of the nic", + "name": "netmask", "type": "string" } ], "type": "set" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "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 ISO attached to the virtual machine", + "name": "isoid", + "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "User VM type", + "name": "vmtype", "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "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 total number of network traffic bytes sent", + "name": "sentbytes", + "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": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + { + "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", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { @@ -82948,23 +83060,126 @@ "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "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 name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" + }, + { + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", + "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" + }, + { + "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 description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" + }, + { + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the 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 memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, + {}, + { + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the type of the template for the virtual machine", + "name": "templatetype", + "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 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 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 domain in which the virtual machine exists", + "name": "domainid", "type": "string" } ] @@ -82991,10 +83206,16 @@ ], "related": "", "response": [ + { + "description": "base64 representation of resource icon", + "name": "base64image", + "type": "string" + }, + {}, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -83008,16 +83229,10 @@ "type": "integer" }, { - "description": "base64 representation of resource icon", - "name": "base64image", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - }, - {} + } ], "since": "4.16.0.0" }, @@ -83027,37 +83242,38 @@ "name": "createPod", "params": [ { - "description": "the name of the Pod", + "description": "comma separated list of storage access groups for the hosts in the pod", "length": 255, - "name": "name", - "required": true, - "type": "string" + "name": "storageaccessgroups", + "required": false, + "since": "4.21.0", + "type": "list" }, { - "description": "the gateway for the Pod", + "description": "the netmask for the Pod", "length": 255, - "name": "gateway", + "name": "netmask", "required": false, "type": "string" }, { - "description": "Allocation state of this Pod for allocation of new resources", + "description": "the gateway for the Pod", "length": 255, - "name": "allocationstate", + "name": "gateway", "required": false, "type": "string" }, { - "description": "the netmask for the Pod", + "description": "Allocation state of this Pod for allocation of new resources", "length": 255, - "name": "netmask", + "name": "allocationstate", "required": false, "type": "string" }, { - "description": "the starting IP address for the Pod", + "description": "the ending IP address for the Pod", "length": 255, - "name": "startip", + "name": "endip", "required": false, "type": "string" }, @@ -83070,43 +83286,68 @@ "type": "uuid" }, { - "description": "comma separated list of storage access groups for the hosts in the pod", + "description": "the starting IP address for the Pod", "length": 255, - "name": "storageaccessgroups", + "name": "startip", "required": false, - "since": "4.21.0", - "type": "list" + "type": "string" }, { - "description": "the ending IP address for the Pod", + "description": "the name of the Pod", "length": 255, - "name": "endip", - "required": false, + "name": "name", + "required": true, "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": "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 starting IP for the Pod. This parameter is deprecated, please use 'startip' from ipranges parameter.", - "name": "startip", + "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": "indicates if range is dedicated for CPVM and SSVM", + "name": "forsystemvms", + "type": "string" + }, + { + "description": "the CIDR for the range", + "name": "cidr", + "type": "string" + }, + { + "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": "indicates Vlan ID for the range", + "name": "vlanid", + "type": "string" + } + ], + "type": "list" }, { "description": "the allocation state of the Pod", @@ -83114,14 +83355,8 @@ "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 of the Pod", + "name": "gateway", "type": "string" }, { @@ -83130,79 +83365,69 @@ "type": "string" }, { - "description": "the gateway of the Pod", - "name": "gateway", + "description": "comma-separated list of storage access groups on the zone", + "name": "zonestorageaccessgroups", "type": "string" }, { - "description": "the netmask of the Pod", - "name": "netmask", + "description": "the Zone ID of the Pod", + "name": "zoneid", "type": "string" }, + { + "description": "the ending IP for the Pod. This parameter is deprecated, please use 'endip' from ipranges parameter.", + "name": "endip", + "type": "list" + }, { "description": "true if the entity/resource has annotations", "name": "hasannotations", "type": "boolean" }, { - "description": "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 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": "the ending IP for the range", - "name": "endip", - "type": "string" - }, - { - "description": "the gateway for the range", - "name": "gateway", - "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" - }, - { - "description": "the CIDR for the range", - "name": "cidr", - "type": "string" - } - ], + "description": "the netmask of the Pod", + "name": "netmask", + "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 UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + { + "description": "the ID of the Pod", + "name": "id", + "type": "string" + }, + { + "description": "comma-separated list of storage access groups for the pod", + "name": "storageaccessgroups", + "type": "string" + }, { "description": "the capacity of the Pod", "name": "capacity", "response": [ { - "description": "the capacity type", - "name": "type", - "type": "short" - }, - { - "description": "the Zone name", - "name": "zonename", + "description": "the Pod name", + "name": "podname", "type": "string" }, { @@ -83211,9 +83436,9 @@ "type": "string" }, { - "description": "The tag for the capacity type", - "name": "tag", - "type": "string" + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" }, { "description": "the Cluster ID", @@ -83221,24 +83446,24 @@ "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 Zone name", + "name": "zonename", + "type": "string" }, { - "description": "the Zone ID", - "name": "zoneid", + "description": "the Pod ID", + "name": "podid", "type": "string" }, { - "description": "the capacity currently in use", - "name": "capacityused", - "type": "long" + "description": "The tag for the capacity type", + "name": "tag", + "type": "string" }, { "description": "the percentage of capacity currently in use", @@ -83246,37 +83471,27 @@ "type": "string" }, { - "description": "the Pod ID", - "name": "podid", + "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 capacity currently in allocated", - "name": "capacityallocated", - "type": "long" + "description": "the capacity type", + "name": "type", + "type": "short" } ], "type": "list" - }, - { - "description": "comma-separated list of storage access groups on the zone", - "name": "zonestorageaccessgroups", - "type": "string" - }, - { - "description": "indicates Vlan ID for the range. This parameter is deprecated, please use 'vlanid' from ipranges parameter.", - "name": "vlanid", - "type": "list" - }, - { - "description": "the ending IP for the Pod. This parameter is deprecated, please use 'endip' from ipranges parameter.", - "name": "endip", - "type": "list" } ] }, @@ -83294,7 +83509,18 @@ } ], "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", @@ -83304,17 +83530,6 @@ "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - {}, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" } ], "since": "4.6.0" @@ -83348,27 +83563,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.11.0" @@ -83379,12 +83594,18 @@ "name": "listVirtualMachinesMetrics", "params": [ { - "description": "the instances by userdata", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "userdataid", - "related": "listCniConfiguration", + "name": "tags", + "required": false, + "type": "map" + }, + { + "description": "the pod ID", + "length": 255, + "name": "podid", + "related": "listPods,createManagementNetworkIpRange", "required": false, - "since": "4.20.1", "type": "uuid" }, { @@ -83396,42 +83617,53 @@ "type": "uuid" }, { - "description": "name of the virtual machine (a substring match is made against the parameter value, data for all matching VMs will be returned)", + "description": "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": "name", + "name": "details", "required": false, - "type": "string" + "type": "list" }, { - "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": "the pod ID", + "description": "list by the service offering", "length": 255, - "name": "podid", - "related": "listPods,createManagementNetworkIpRange", + "name": "serviceofferingid", + "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", "required": false, + "since": "4.4", "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 icon for VMs", "length": 255, - "name": "isrecursive", + "name": "showicon", "required": false, + "since": "4.16.0.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": "the ID of the virtual machine", "length": 255, - "name": "isvnf", + "name": "id", + "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,createVMFromBackup,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "required": false, - "since": "4.19.0", - "type": "boolean" + "type": "uuid" + }, + { + "description": "the instances by userdata", + "length": 255, + "name": "userdataid", + "related": "listCniConfiguration", + "required": false, + "since": "4.20.1", + "type": "uuid" }, { "description": "the availability zone ID", @@ -83450,30 +83682,6 @@ "since": "4.18.0", "type": "uuid" }, - { - "description": "The ID of the Orchestrator extension for the VM", - "length": 255, - "name": "extensionid", - "related": "listExtensions,deleteExtension,updateExtension,registerExtension,unregisterExtension", - "required": false, - "since": "4.21.0", - "type": "uuid" - }, - { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", - "length": 255, - "name": "displayvm", - "required": false, - "since": "4.4", - "type": "boolean" - }, - { - "description": "list vms by iso", - "length": 255, - "name": "isoid", - "required": false, - "type": "uuid" - }, { "description": "the group ID", "length": 255, @@ -83483,87 +83691,72 @@ "type": "uuid" }, { - "description": "list by network id", - "length": 255, - "name": "networkid", - "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", - "required": false, - "type": "uuid" - }, - { - "description": "the storage ID where vm's volumes belong to", - "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", - "required": false, - "type": "uuid" - }, - { - "description": "flag to display the resource icon for VMs", + "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": "showicon", + "name": "gpuenabled", "required": false, - "since": "4.16.0.0", + "since": "4.21.0", "type": "boolean" }, { - "description": "List resources by tags (key/value pairs)", + "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": "tags", + "name": "state", "required": false, - "type": "map" + "type": "string" }, { - "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": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "", + "description": "Whether to return only leased instances", "length": 255, - "name": "page", + "name": "leased", "required": false, - "type": "integer" + "since": "4.21.0", + "type": "boolean" }, { - "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": "the target hypervisor for the template", "length": 255, - "name": "details", + "name": "hypervisor", "required": false, - "type": "list" + "type": "string" }, { - "description": "state of the virtual machine. Possible values are: Running, Stopped, Present, Destroyed, Expunged. Present is used for the state equal not destroyed.", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "state", + "name": "account", "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": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "accumulate", + "name": "displayvm", "required": false, - "since": "4.17.0", + "since": "4.4", "type": "boolean" }, { - "description": "list vms by affinity group", + "description": "list by network id", "length": 255, - "name": "affinitygroupid", - "related": "createAffinityGroup,listAffinityGroups", + "name": "networkid", + "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", "required": false, "type": "uuid" }, { - "description": "list by network type; true if need to list vms using Virtual Network, false otherwise", + "description": "the cluster ID", "length": 255, - "name": "forvirtualnetwork", + "name": "clusterid", + "related": "addCluster,updateCluster", "required": false, - "type": "boolean" + "type": "uuid" }, { "description": "", @@ -83573,73 +83766,66 @@ "type": "integer" }, { - "description": "Flag to indicate if the VMs should be filtered by GPU support. If set to true, only VMs that support GPU will be returned.", + "description": "Whether to return the VMs' user data or not. By default, user data will not be returned.", "length": 255, - "name": "gpuenabled", + "name": "userdata", "required": false, - "since": "4.21.0", + "since": "4.18.0.0", "type": "boolean" }, { "description": "the IDs of the virtual machines, mutually exclusive with id", "length": 255, "name": "ids", - "related": "assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm", + "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,createVMFromBackup,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "required": false, "since": "4.4", "type": "list" }, { - "description": "list vms by ssh keypair name", + "description": "The ID of the Orchestrator extension for the VM", "length": 255, - "name": "keypair", + "name": "extensionid", + "related": "listExtensions,deleteExtension,updateExtension,registerExtension,unregisterExtension", "required": false, - "type": "string" + "since": "4.21.0", + "type": "uuid" }, { - "description": "List by keyword", + "description": "CPU arch of the VM", "length": 255, - "name": "keyword", + "name": "arch", "required": false, + "since": "4.20.1", "type": "string" }, { - "description": "list vms by vpc", - "length": 255, - "name": "vpcid", - "related": "listVPCs,createVPC,listVPCs,updateVPC", - "required": false, - "type": "uuid" - }, - { - "description": "list by the service offering", + "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": "serviceofferingid", - "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", + "name": "accumulate", "required": false, - "since": "4.4", - "type": "uuid" + "since": "4.17.0", + "type": "boolean" }, { - "description": "CPU arch of the VM", + "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": "arch", + "name": "isvnf", "required": false, - "since": "4.20.1", - "type": "string" + "since": "4.19.0", + "type": "boolean" }, { - "description": "list by the High Availability offering; true if filtering VMs with HA enabled; false for VMs with HA disabled", + "description": "makes the API's response contains only the resource count", "length": 255, - "name": "haenable", + "name": "retrieveonlyresourcecount", "required": false, - "since": "4.15", "type": "boolean" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "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" }, @@ -83652,59 +83838,57 @@ "type": "uuid" }, { - "description": "Whether to return only leased instances", + "description": "list vms by iso", "length": 255, - "name": "leased", + "name": "isoid", "required": false, - "since": "4.21.0", - "type": "boolean" + "type": "uuid" }, { - "description": "list by the backup offering", + "description": "list vms by template", "length": 255, - "name": "backupofferingid", - "related": "listBackupOfferings,updateBackupOffering", + "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.17", "type": "uuid" }, { - "description": "the target hypervisor for the template", + "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": "hypervisor", + "name": "name", "required": false, "type": "string" }, { - "description": "the security group ID", + "description": "list vms by affinity group", "length": 255, - "name": "securitygroupid", - "related": "updateSecurityGroup", + "name": "affinitygroupid", + "related": "createAffinityGroup,listAffinityGroups", "required": false, - "since": "4.15", "type": "uuid" }, { - "description": "the cluster ID", + "description": "list vms by ssh keypair name", "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", + "name": "keypair", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "makes the API's response contains only the resource count", + "description": "list by network type; true if need to list vms using Virtual Network, false otherwise", "length": 255, - "name": "retrieveonlyresourcecount", + "name": "forvirtualnetwork", "required": false, "type": "boolean" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "the security group ID", "length": 255, - "name": "account", + "name": "securitygroupid", + "related": "updateSecurityGroup", "required": false, - "type": "string" + "since": "4.15", + "type": "uuid" }, { "description": "the host ID", @@ -83715,356 +83899,296 @@ "type": "uuid" }, { - "description": "list vms by template", + "description": "the user ID that created the VM and is under the account that owns the VM", "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": "userid", + "related": "disableUser,getUser,listUsers,lockUser", "required": false, "type": "uuid" }, { - "description": "the ID of the virtual machine", + "description": "list by the backup offering", "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", + "name": "backupofferingid", + "related": "listBackupOfferings,updateBackupOffering", + "required": false, + "since": "4.17", + "type": "uuid" + }, + { + "description": "list vms by vpc", + "length": 255, + "name": "vpcid", + "related": "listVPCs,createVPC,listVPCs,updateVPC", + "required": false, + "type": "uuid" + }, + { + "description": "the storage ID where vm's volumes belong to", + "length": 255, + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", "required": false, "type": "uuid" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "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" } ], "related": "listVirtualMachinesMetrics", "response": [ { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", + "description": "the total disk iops", + "name": "diskiopstotal", "type": "long" }, { - "description": "the list of nics associated with vm", - "name": "nic", - "response": [ - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - }, - { - "description": "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 IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - } - ], - "type": "set" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", + "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" + "description": "the project name of the vm", + "name": "project", + "type": "string" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", + "description": "the read (IO) of disk on the VM", + "name": "diskioread", "type": "long" }, { - "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": "network read in MiB", - "name": "networkread", - "type": "string" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", - "type": "string" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "User VM type", - "name": "vmtype", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" + "description": "the maximum X resolution", + "name": "maxresolutionx", + "type": "long" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "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": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, + {}, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", + "description": "the list of resource tags associated", + "name": "tags", "response": [ { - "description": "the ID of the affinity group", - "name": "id", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the account owning the affinity group", - "name": "account", + "description": "id of the resource", + "name": "resourceid", "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": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "description": "path of the Domain the affinity group belongs to", + "description": "path of the Domain associated with the tag", "name": "domainpath", "type": "string" }, { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", - "type": "list" + "description": "tag key name", + "name": "key", + "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "set" }, { - "description": "CPU arch of the VM", - "name": "arch", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "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 memory used by the VM in KiB", - "name": "memorykbs", + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, + { + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", + "type": "string" + }, + { + "description": "Base64 string containing the user data", + "name": "userdata", + "type": "string" + }, + { + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", "type": "long" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "the name of the host for the virtual machine", + "name": "hostname", + "type": "string" }, { - "description": "the video RAM size in MB", - "name": "videoram", + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" + }, + { + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", + "type": "string" + }, + { + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", "type": "long" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "disk write in MiB", + "name": "diskwrite", + "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": "Guest vm Boot Type", + "name": "boottype", + "type": "string" + }, + { + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" + }, + { + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" + }, + { + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + { + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", + "type": "string" + }, + { + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { @@ -84073,13 +84197,33 @@ "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", + "description": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" + }, + { + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", + "type": "string" + }, + { + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" + }, + { + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", "type": "boolean" }, { @@ -84088,165 +84232,301 @@ "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + { + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", "type": "long" }, { - "description": "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 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": "Instance lease expiry date", - "name": "leaseexpirydate", - "type": "date" + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", + "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 incoming network traffic on the VM in KiB", - "name": "networkkbsread", + "description": "device ID of the root volume", + "name": "rootdeviceid", "type": "long" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", + "description": "the state of the virtual machine", + "name": "state", + "type": "string" + }, + { + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "type": "string" + }, + { + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", + "type": "string" + }, + { + "description": "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; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" + }, + { + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", + "type": "string" + }, + { + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" + }, + { + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" + }, + { + "description": "the list of nics associated with vm", + "name": "nic", "response": [ { - "description": "the account associated with the tag", - "name": "account", + "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": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the ID of the nic", + "name": "id", + "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 ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "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 Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "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 isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", - "type": "string" + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" } ], "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 date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "the project name of the vm", - "name": "project", - "type": "string" + "description": "the maximum Y resolution", + "name": "maxresolutiony", + "type": "long" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "network write in MiB", - "name": "networkwrite", + "description": "network read in MiB", + "name": "networkread", "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "the maximum number of display heads", + "name": "maxheads", + "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 type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "the total cpu capacity in Ghz", - "name": "cputotal", + "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 group name of the virtual machine", - "name": "group", + "description": "disk read in MiB", + "name": "diskread", "type": "string" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "User VM type", + "name": "vmtype", "type": "string" }, { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { @@ -84255,84 +84535,23 @@ "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", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", - "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 user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "CPU arch of the VM", + "name": "arch", "type": "string" }, { @@ -84341,99 +84560,63 @@ "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "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": "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": "Instance lease expiry action", - "name": "leaseexpiryaction", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", + "description": "Instance lease duration in days", + "name": "leaseduration", "type": "integer" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", "type": "string" }, { - "description": "the name of the gpu card to which service offering is linked", - "name": "gpucardname", + "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": "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", + "description": "the total cpu capacity in Ghz", + "name": "cputotal", "type": "string" }, { @@ -84441,23 +84624,13 @@ "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 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": "path of the Domain the security group belongs to", + "name": "domainpath", "type": "string" }, { @@ -84465,104 +84638,109 @@ "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "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": "tag value", + "name": "value", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], "type": "set" }, { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", + "description": "the account owning the security group", + "name": "account", + "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 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": "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", + "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": "the protocol of the security group rule", + "name": "protocol", + "type": "string" }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag value", - "name": "value", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -84571,18 +84749,18 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -84591,147 +84769,152 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "tag value", + "name": "value", "type": "string" }, { "description": "the ID of the domain associated with the tag", "name": "domainid", "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", + "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", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the 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 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 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 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 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": "security group name", - "name": "securitygroupname", + "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 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": "tag value", - "name": "value", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the 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 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" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "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": "tag key name", - "name": "key", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -84743,185 +84926,217 @@ "type": "set" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", + "description": "the ending IP of the security group rule ", + "name": "endport", "type": "integer" }, { - "description": "account owning the security group rule", - "name": "account", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" } ], "type": "set" }, { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", + "description": "the project id of the group", + "name": "projectid", "type": "string" }, { - "description": "the description of the security group", - "name": "description", + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "the project name of the group", + "name": "project", "type": "string" } ], "type": "set" }, { - "description": "OS name of the vm", - "name": "osdisplayname", - "type": "string" - }, - { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", - "type": "string" - }, - { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "type": "string" - }, - { - "description": "disk read in MiB", - "name": "diskread", - "type": "string" - }, - { - "description": "the maximum X resolution", - "name": "maxresolutionx", - "type": "long" + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "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": "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 count of GPUs on the virtual machine", + "name": "gpucount", + "type": "integer" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "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 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 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" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", - "type": "string" + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ + { + "description": "the account owning the affinity group", + "name": "account", + "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 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": "the project ID of the affinity group", + "name": "projectid", + "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": "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" + } + ], + "type": "set" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "the name of the vgpu profile to which service offering is linked", - "name": "vgpuprofilename", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "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": "device type of the root volume", - "name": "rootdevicetype", - "type": "string" + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", "type": "long" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" - }, - { - "description": "Guest vm Boot Type", - "name": "boottype", + "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", - "type": "string" + "description": "the video RAM size in MB", + "name": "videoram", + "type": "long" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "Instance lease duration in days", - "name": "leaseduration", - "type": "integer" + "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": "network write in MiB", + "name": "networkwrite", "type": "string" } ] @@ -84932,26 +85147,26 @@ "name": "listHosts", "params": [ { - "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": "CPU Arch of the host", "length": 255, - "name": "resourcestate", + "name": "arch", "required": false, + "since": "4.20.1", "type": "string" }, { - "description": "hypervisor type of host: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator", + "description": "", "length": 255, - "name": "hypervisor", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "lists hosts existing in particular cluster", + "description": "", "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { "description": "the state of the host", @@ -84961,20 +85176,11 @@ "type": "string" }, { - "description": "CPU Arch of the host", - "length": 255, - "name": "arch", - "required": false, - "since": "4.20.1", - "type": "string" - }, - { - "description": "the id of the management server", + "description": "lists hosts in the same cluster as this VM and flag hosts with enough CPU/RAm to host this VM", "length": 255, - "name": "managementserverid", - "related": "listManagementServers", + "name": "virtualmachineid", + "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,createVMFromBackup,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "required": false, - "since": "4.21.0", "type": "uuid" }, { @@ -84985,193 +85191,312 @@ "type": "list" }, { - "description": "List by keyword", + "description": "the id of the host", "length": 255, - "name": "keyword", + "name": "id", + "related": "declareHostAsDegraded,listHosts,reconnectHost", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "lists hosts in the same cluster as this VM and flag hosts with enough CPU/RAm to host this VM", + "description": "the Zone 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": "zoneid", + "related": "listZones", "required": false, "type": "uuid" }, { - "description": "", + "description": "lists hosts existing in particular cluster", "length": 255, - "name": "pagesize", + "name": "clusterid", + "related": "addCluster,updateCluster", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "list hosts by its out-of-band management interface's power state. Its value can be one of [On, Off, Unknown]", + "description": "the name of the host", "length": 255, - "name": "outofbandmanagementpowerstate", + "name": "name", "required": false, "type": "string" }, { - "description": "if true, list only hosts dedicated to HA", + "description": "hypervisor type of host: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator", "length": 255, - "name": "hahost", + "name": "hypervisor", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "the host type", + "description": "the Pod ID for the host", "length": 255, - "name": "type", + "name": "podid", + "related": "listPods,createManagementNetworkIpRange", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the id of the host", + "description": "list hosts for which out-of-band management is enabled", "length": 255, - "name": "id", - "related": "declareHostAsDegraded,listHosts,reconnectHost", + "name": "outofbandmanagementenabled", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "the Zone ID for the host", + "description": "the id of the management server", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "managementserverid", + "related": "listManagementServers", "required": false, + "since": "4.21.0", "type": "uuid" }, { - "description": "", + "description": "list hosts by its out-of-band management interface's power state. Its value can be one of [On, Off, Unknown]", "length": 255, - "name": "page", + "name": "outofbandmanagementpowerstate", "required": false, - "type": "integer" + "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": "the name of the host", + "description": "the name of the storage access group", "length": 255, - "name": "name", + "name": "storageaccessgroup", "required": false, + "since": "4.21.0", "type": "string" }, { - "description": "list hosts for which out-of-band management is enabled", + "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": "outofbandmanagementenabled", + "name": "resourcestate", "required": false, - "type": "boolean" + "type": "string" }, { - "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": "if true, list only hosts dedicated to HA", + "length": 255, + "name": "hahost", + "required": false, + "type": "boolean" } ], "related": "declareHostAsDegraded,reconnectHost", "response": [ + { + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "capabilities of the host", + "name": "capabilities", + "type": "string" + }, + { + "description": "the admin that annotated this host", + "name": "username", + "type": "string" + }, + { + "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", + "type": "long" + }, + { + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" + }, + { + "description": "the cpu average load on the host", + "name": "cpuloadaverage", + "type": "double" + }, + { + "description": "the Pod name of the host", + "name": "podname", + "type": "string" + }, + { + "description": "true if the host supports encryption", + "name": "encryptionsupported", + "type": "boolean" + }, + { + "description": "the Pod ID of the host", + "name": "podid", + "type": "string" + }, + { + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" + }, { "description": "comma-separated list of implicit host tags for the host", "name": "implicithosttags", "type": "string" }, { - "description": "the resource state of the host", - "name": "resourcestate", + "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", + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", + "type": "long" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the last time this host was annotated", + "name": "lastannotated", + "type": "date" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the host hypervisor", + "name": "hypervisor", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "comma-separated list of tags for the host", + "name": "hosttags", "type": "string" }, { - "description": "comma-separated list of explicit host tags for the host", - "name": "explicithosttags", + "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", "type": "string" }, { - "description": "the Pod ID of the host", - "name": "podid", + "description": "the OS category name of the host", + "name": "oscategoryname", "type": "string" }, { - "description": "the Pod name of the host", - "name": "podname", + "description": "CPU Arch of the host", + "name": "arch", "type": "string" }, { - "description": "the cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" + "description": "the IP address of the host", + "name": "ipaddress", + "type": "string" }, { - "description": "the host HA information information", - "name": "hostha", - "type": "hostharesponse" + "description": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", + "type": "boolean" + }, + { + "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": "the amount of the host's memory currently used", + "name": "memoryused", + "type": "long" + }, + { + "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": "the date and time the host was created", + "name": "created", + "type": "date" }, { "description": "the OS category ID of the host", "name": "oscategoryid", "type": "string" }, - {}, { - "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 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", + "type": "string" }, { - "description": "the CPU speed of the host", - "name": "cpuspeed", + "description": "the CPU number of the host", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "Total GPUs on the Host", + "name": "gputotal", "type": "long" }, { - "description": "the host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" + "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 for the host", - "name": "storageaccessgroups", + "description": "the date and time the host was last pinged", + "name": "lastpinged", + "type": "date" + }, + { + "description": "the virtual machine id for host type ConsoleProxy and SecondaryStorageVM", + "name": "virtualmachineid", "type": "string" }, { - "description": "Used GPUs on the Host", - "name": "gpuused", + "description": "the incoming network traffic on the host", + "name": "networkkbsread", "type": "long" }, { - "description": "the admin that annotated this host", - "name": "username", + "description": "comma-separated list of explicit host tags for the host", + "name": "explicithosttags", "type": "string" }, { @@ -85180,8 +85505,13 @@ "type": "long" }, { - "description": "the host hypervisor", - "name": "hypervisor", + "description": "the host HA information information", + "name": "hostha", + "type": "hostharesponse" + }, + { + "description": "the management server ID of the host", + "name": "managementserverid", "type": "string" }, { @@ -85190,48 +85520,49 @@ "type": "string" }, { - "description": "Total GPUs on the Host", - "name": "gputotal", - "type": "long" + "description": "the Zone ID of the host", + "name": "zoneid", + "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 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": "CPU Arch of the host", - "name": "arch", - "type": "string" + "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 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 zone", - "name": "zonestorageaccessgroups", - "type": "string" + "description": "true if the host is disconnected. False otherwise.", + "name": "disconnected", + "type": "date" }, { - "description": "the OS category name of the host", - "name": "oscategoryname", - "type": "string" + "description": "the host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" }, { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", + "description": "the amount of the host's memory currently allocated in bytes", + "name": "memoryallocatedbytes", "type": "long" }, + {}, { - "description": "the management server ID of the host", - "name": "managementserverid", + "description": "the hypervisor version", + "name": "hypervisorversion", "type": "string" }, { @@ -85240,9 +85571,34 @@ "type": "boolean" }, { - "description": "the host type", - "name": "type", - "type": "type" + "description": "comma-separated list of storage access groups on the zone", + "name": "zonestorageaccessgroups", + "type": "string" + }, + { + "description": "true if the host supports instance conversion (using virt-v2v)", + "name": "instanceconversionsupported", + "type": "boolean" + }, + { + "description": "the Zone name of the host", + "name": "zonename", + "type": "string" + }, + { + "description": "events available for the host", + "name": "events", + "type": "string" + }, + { + "description": "the cluster type of the cluster that host belongs to", + "name": "clustertype", + "type": "string" + }, + { + "description": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", + "type": "string" }, { "description": "GPU cards present in the host", @@ -85253,28 +85609,28 @@ "name": "vgpu", "response": [ { - "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", + "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" }, { - "description": "Maximum Y resolution per display", - "name": "maxresolutiony", + "description": "Maximum X resolution per display", + "name": "maxresolutionx", "type": "long" }, { - "description": "Maximum no. of vgpu per gpu card (pgpu)", - "name": "maxvgpuperpgpu", + "description": "Maximum displays per user", + "name": "maxheads", "type": "long" }, { @@ -85283,13 +85639,13 @@ "type": "long" }, { - "description": "Model Name of vGPU", - "name": "vgputype", - "type": "string" + "description": "Maximum Y resolution per display", + "name": "maxresolutiony", + "type": "long" }, { - "description": "Video RAM for this vGPU type", - "name": "videoram", + "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", + "name": "maxcapacity", "type": "long" } ], @@ -85304,39 +85660,40 @@ "type": "list" }, { - "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": "the resource state of the host", + "name": "resourcestate", "type": "string" }, + {}, { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", - "type": "boolean" + "description": "Used GPUs on the Host", + "name": "gpuused", + "type": "long" }, { - "description": "events available for the host", - "name": "events", + "description": "the cluster ID of the host", + "name": "clusterid", "type": "string" }, { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", + "description": "the CPU speed of the host", + "name": "cpuspeed", "type": "long" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" + "description": "the host version", + "name": "version", + "type": "string" }, { - "description": "the state of the host", - "name": "state", - "type": "status" + "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", + "name": "hahost", + "type": "boolean" }, { "description": "the cluster name of the host", @@ -85344,185 +85701,43 @@ "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 IP address of the host", - "name": "ipaddress", - "type": "string" + "description": "the amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", + "type": "long" }, { "description": "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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the hypervisor version", - "name": "hypervisorversion", - "type": "string" - }, - { - "description": "the amount of the host's memory currently used", - "name": "memoryused", - "type": "long" - }, - { - "description": "the amount of the host's CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", - "type": "string" - }, - { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", - "type": "boolean" - }, - { - "description": "true if the host supports encryption", - "name": "encryptionsupported", - "type": "boolean" - }, { "description": "The ID of extension for this cluster", "name": "extensionid", "type": "string" }, { - "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", - "type": "long" - }, - { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", - "type": "string" - }, - { - "description": "the last annotation set on this host by an admin", - "name": "annotation", + "description": "the management server name of the host", + "name": "managementservername", "type": "string" }, - { - "description": "the amount of the host's CPU currently allocated in MHz", - "name": "cpuallocatedvalue", - "type": "long" - }, - { - "description": "the date and time the host was last pinged", - "name": "lastpinged", - "type": "date" - }, - { - "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", - "name": "suitableformigration", - "type": "boolean" - }, { "description": "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 amount of the host's CPU currently used", - "name": "cpuused", - "type": "string" - }, - { - "description": "the Zone ID of the host", - "name": "zoneid", - "type": "string" - }, - { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", - "type": "string" - }, - {}, - { - "description": "the Zone name of the host", - "name": "zonename", - "type": "string" - }, - { - "description": "the last time this host was annotated", - "name": "lastannotated", - "type": "date" - }, - { - "description": "the management server name of the host", - "name": "managementservername", - "type": "string" - }, - { - "description": "The name of extension for this cluster", - "name": "extensionname", - "type": "string" - }, - { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" - }, - { - "description": "the number of CPU sockets on the host", - "name": "cpusockets", - "type": "integer" - }, - { - "description": "the name of the host", - "name": "name", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - {}, - { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", - "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 last annotation set on this host by an admin", + "name": "annotation", "type": "string" }, { - "description": "the date and time the host was created", - "name": "created", - "type": "date" - }, - { - "description": "the host version", - "name": "version", + "description": "comma-separated list of storage access groups on the cluster", + "name": "clusterstorageaccessgroups", "type": "string" } ] @@ -85532,13 +85747,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 +85754,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 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": "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" + } ] }, { @@ -85588,6 +85803,13 @@ } ], "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", @@ -85598,13 +85820,6 @@ "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", @@ -85619,11 +85834,12 @@ "name": "updateStoragePool", "params": [ { - "description": "false to disable the pool for allocation of new volumes, true to enable it back.", + "description": "the Id of the storage pool", "length": 255, - "name": "enabled", - "required": false, - "type": "boolean" + "name": "id", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "required": true, + "type": "uuid" }, { "description": "Whether the informed tag is a JS interpretable rule or not.", @@ -85633,26 +85849,28 @@ "type": "boolean" }, { - "description": "IOPS CloudStack can provision from this storage pool", + "description": "false to disable the pool for allocation of new volumes, true to enable it back.", "length": 255, - "name": "capacityiops", + "name": "enabled", "required": false, - "type": "long" + "type": "boolean" }, { - "description": "the Id of the storage pool", + "description": "the URL of the storage pool", "length": 255, - "name": "id", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", - "required": true, - "type": "uuid" + "name": "url", + "required": false, + "since": "4.19.0", + "type": "string" }, { - "description": "bytes CloudStack can provision from this storage pool", + "description": "Change the name of the storage pool", "length": 255, - "name": "capacitybytes", + "name": "name", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", "required": false, - "type": "long" + "since": "4.15", + "type": "string" }, { "description": "the details for the storage pool", @@ -85663,107 +85881,94 @@ "type": "map" }, { - "description": "Change the name of the storage pool", + "description": "bytes CloudStack can provision from this storage pool", "length": 255, - "name": "name", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "name": "capacitybytes", "required": false, - "since": "4.15", - "type": "string" + "type": "long" }, { - "description": "comma-separated list of tags for the storage pool", + "description": "IOPS CloudStack can provision from this storage pool", "length": 255, - "name": "tags", + "name": "capacityiops", "required": false, - "type": "list" + "type": "long" }, { - "description": "the URL of the storage pool", + "description": "comma-separated list of tags for the storage pool", "length": 255, - "name": "url", + "name": "tags", "required": false, - "since": "4.19.0", - "type": "string" + "type": "list" } ], "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", "response": [ { - "description": "the date and time the storage pool was created", - "name": "created", - "type": "date" - }, - { - "description": "the overprovisionfactor for the storage pool", - "name": "overprovisionfactor", + "description": "the storage pool path", + "name": "path", "type": "string" }, { - "description": "the Zone ID of the storage pool", - "name": "zoneid", - "type": "string" + "description": "true if this pool is suitable to migrate a volume, false otherwise", + "name": "suitableformigration", + "type": "boolean" }, { - "description": "the name of the cluster for the storage pool", - "name": "clustername", + "description": "the Pod ID of the storage pool", + "name": "podid", "type": "string" }, - {}, { - "description": "the tags for the storage pool", - "name": "tags", + "description": "the Pod name of the storage pool", + "name": "podname", "type": "string" }, { - "description": "the storage pool path", - "name": "path", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", - "type": "boolean" - }, - { - "description": "total min IOPS currently in use by volumes", - "name": "allocatediops", - "type": "long" - }, { "description": "the name of the storage pool", "name": "name", "type": "string" }, { - "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 ID of the cluster for the storage pool", - "name": "clusterid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the hypervisor type of the storage pool", - "name": "hypervisor", + "description": "the storage pool type", + "name": "type", "type": "string" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", + "description": "the total disk size of the storage pool", + "name": "disksizetotal", "type": "long" }, { - "description": "the storage access groups for the storage pool", - "name": "storageaccessgroups", + "description": "the overprovisionfactor for the storage pool", + "name": "overprovisionfactor", "type": "string" }, + {}, + { + "description": "the state of the storage pool", + "name": "state", + "type": "storagepoolstatus" + }, { - "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": "the scope of the storage pool", @@ -85771,13 +85976,24 @@ "type": "string" }, { - "description": "the Pod ID of the storage pool", - "name": "podid", + "description": "whether this pool is managed or not", + "name": "managed", + "type": "boolean" + }, + {}, + { + "description": "the IP address of the storage pool", + "name": "ipaddress", "type": "string" }, { - "description": "the total disk size of the storage pool", - "name": "disksizetotal", + "description": "total IOPS currently in use", + "name": "usediops", + "type": "long" + }, + { + "description": "the pool's currently allocated disk size", + "name": "disksizeallocated", "type": "long" }, { @@ -85786,19 +86002,14 @@ "type": "string" }, { - "description": "the storage pool capabilities", - "name": "storagecapabilities", - "type": "map" - }, - { - "description": "the Pod name of the storage pool", - "name": "podname", + "description": "the name of the cluster for the storage pool", + "name": "clustername", "type": "string" }, { - "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": "true if the entity/resource has annotations", @@ -85806,44 +86017,59 @@ "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the nfs mount options for the storage pool", + "name": "nfsmountopts", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the pool's currently used disk size", + "name": "disksizeused", + "type": "long" }, { - "description": "the storage pool type", - "name": "type", + "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": "total IOPS currently in use", - "name": "usediops", + "description": "the storage access groups for the storage pool", + "name": "storageaccessgroups", + "type": "string" + }, + { + "description": "the storage pool custom stats", + "name": "storagecustomstats", + "type": "map" + }, + { + "description": "bytes CloudStack can provision from this storage pool", + "name": "capacitybytes", "type": "long" }, { - "description": "the ID of the storage pool", - "name": "id", + "description": "the tags for the storage pool", + "name": "tags", "type": "string" }, { - "description": "the Zone name of the storage pool", - "name": "zonename", - "type": "string" + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "the ID of the cluster for the storage pool", + "name": "clusterid", + "type": "string" }, { - "description": "IOPS CloudStack can provision from this storage pool", - "name": "capacityiops", - "type": "long" + "description": "the hypervisor type of the storage pool", + "name": "hypervisor", + "type": "string" }, { "description": "the storage pool details", @@ -85851,20 +86077,14 @@ "type": "map" }, { - "description": "the storage pool custom stats", - "name": "storagecustomstats", - "type": "map" - }, - { - "description": "the state of the storage pool", - "name": "state", - "type": "storagepoolstatus" + "description": "the ID of the storage pool", + "name": "id", + "type": "string" }, - {}, { - "description": "whether this pool is managed or not", - "name": "managed", - "type": "boolean" + "description": "the storage pool capabilities", + "name": "storagecapabilities", + "type": "map" } ], "since": "3.0.0" @@ -85874,13 +86094,6 @@ "isasync": false, "name": "listBackupRepositories", "params": [ - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, { "description": "List by keyword", "length": 255, @@ -85888,13 +86101,6 @@ "required": false, "type": "string" }, - { - "description": "the backup repository provider", - "length": 255, - "name": "provider", - "required": false, - "type": "string" - }, { "description": "ID of the backup repository", "length": 255, @@ -85904,11 +86110,12 @@ "type": "uuid" }, { - "description": "name of the backup repository", + "description": "ID of the zone where the backup repository is to be added", "length": 255, - "name": "name", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "string" + "type": "uuid" }, { "description": "", @@ -85918,24 +86125,42 @@ "type": "integer" }, { - "description": "ID of the zone where the backup repository is to be added", + "description": "", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" + }, + { + "description": "name of the backup repository", + "length": 255, + "name": "name", + "required": false, + "type": "string" + }, + { + "description": "the backup repository provider", + "length": 255, + "name": "provider", + "required": false, + "type": "string" } ], "related": "addBackupRepository", "response": [ { - "description": "the date and time the backup repository was added", - "name": "created", - "type": "date" + "description": "the name of the backup repository", + "name": "name", + "type": "string" }, { - "description": "backup type", - "name": "type", + "description": "the address / url of the backup repository", + "name": "address", + "type": "string" + }, + { + "description": "the ID of the backup repository", + "name": "id", "type": "string" }, { @@ -85943,48 +86168,48 @@ "name": "zoneid", "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 backup repository was added", + "name": "created", + "type": "date" }, + {}, { - "description": "the Zone name of the backup repository", - "name": "zonename", + "description": "name of the provider", + "name": "provider", "type": "string" }, { - "description": "the ID of the backup repository", - "name": "id", - "type": "string" + "description": "the backups in this repository can be used to create Instances on all Zones", + "name": "crosszoneinstancecreation", + "type": "boolean" }, { - "description": "capacity of the backup repository", - "name": "capacitybytes", - "type": "long" + "description": "the Zone name of the backup repository", + "name": "zonename", + "type": "string" }, { - "description": "name of the provider", - "name": "provider", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "the name of the backup repository", - "name": "name", + "description": "backup type", + "name": "type", "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 UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, - {} + } ], "since": "4.20.0" }, @@ -85994,26 +86219,26 @@ "name": "listTungstenFabricTag", "params": [ { - "description": "the uuid of Tungsten-Fabric vm", + "description": "the uuid of Tungsten-Fabric application policy set", "length": 255, - "name": "vmuuid", + "name": "applicationpolicysetuuid", "required": false, "type": "string" }, { - "description": "the ID of zone", + "description": "", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "the uuid of Tungsten-Fabric tag", + "description": "the ID of zone", "length": 255, - "name": "taguuid", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "string" + "type": "uuid" }, { "description": "", @@ -86023,16 +86248,16 @@ "type": "integer" }, { - "description": "the uuid of Tungsten-Fabric nic", + "description": "the uuid of Tungsten-Fabric vm", "length": 255, - "name": "nicuuid", + "name": "vmuuid", "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,65 +86269,54 @@ "type": "string" }, { - "description": "the uuid of Tungsten-Fabric policy", + "description": "List by keyword", "length": 255, - "name": "policyuuid", + "name": "keyword", "required": false, "type": "string" }, { - "description": "", + "description": "the uuid of Tungsten-Fabric nic", "length": 255, - "name": "pagesize", + "name": "nicuuid", "required": false, - "type": "integer" + "type": "string" }, { - "description": "the uuid of Tungsten-Fabric application policy set", + "description": "the uuid of Tungsten-Fabric tag", "length": 255, - "name": "applicationpolicysetuuid", + "name": "taguuid", "required": false, "type": "string" } ], "related": "applyTungstenFabricTag", "response": [ - { - "description": "list Tungsten-Fabric policy", - "name": "policy", - "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": "list Tungsten-Fabric network", - "name": "network", + "description": "list Tungsten-Fabric policy", + "name": "policy", "type": "list" }, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" + "description": "Tungsten-Fabric tag type uuid", + "name": "uuid", + "type": "string" }, { "description": "list Tungsten-Fabric nic", "name": "nic", "type": "list" }, + {}, { - "description": "Tungsten-Fabric tag type uuid", - "name": "uuid", - "type": "string" + "description": "list Tungsten-Fabric network", + "name": "network", + "type": "list" }, { "description": "list Tungsten-Fabric vm", @@ -86114,10 +86328,21 @@ "name": "name", "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" } ] }, @@ -86127,18 +86352,19 @@ "name": "importLdapUsers", "params": [ { - "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", + "description": "Creates the account under the specified role.", "length": 255, - "name": "timezone", + "name": "roleid", + "related": "createRole,listRoles,updateRole", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "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.", @@ -86148,24 +86374,23 @@ "type": "string" }, { - "description": "Specifies the domain to which the ldap users are to be imported. If no domain is specified, a domain will created using group parameter. If the group is also not specified, a domain name based on the OU information will be created. If no OU hierarchy exists, will be defaulted to ROOT domain", + "description": "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": "domainid", - "related": "createDomain,listDomains,listDomains,moveDomain", + "name": "group", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "Type of the account. Specify 0 for user, 1 for root admin, and 2 for domain admin", + "description": "details for account used to store specific parameters", "length": 255, - "name": "accounttype", + "name": "accountdetails", "required": false, - "type": "integer" + "type": "map" }, { - "description": "", + "description": "Type of the account. Specify 0 for user, 1 for root admin, and 2 for domain admin", "length": 255, - "name": "page", + "name": "accounttype", "required": false, "type": "integer" }, @@ -86177,76 +86402,76 @@ "type": "integer" }, { - "description": "Specifies the group name from which the ldap users are to be imported. If no group is specified, all the users will be imported.", + "description": "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": "group", + "name": "domainid", + "related": "createDomain,listDomains,listDomains,moveDomain", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "details for account used to store specific parameters", + "description": "List by keyword", "length": 255, - "name": "accountdetails", + "name": "keyword", "required": false, - "type": "map" + "type": "string" }, { - "description": "Creates the account under the specified role.", + "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", "length": 255, - "name": "roleid", - "related": "createRole,listRoles,updateRole", + "name": "timezone", "required": false, - "type": "uuid" + "type": "string" } ], "related": "searchLdap", "response": [ { - "description": "The user's domain", - "name": "domain", + "description": "The authentication source for this user as known to the system or empty if the user is not yet in cloudstack.", + "name": "conflictingusersource", "type": "string" }, - {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "The user's username", "name": "username", "type": "string" }, {}, - { - "description": "The user's email", - "name": "email", - "type": "string" - }, { "description": "The user's principle", "name": "principal", "type": "string" }, { - "description": "The authentication source for this user as known to the system or empty if the user is not yet in cloudstack.", - "name": "conflictingusersource", + "description": "The user's lastname", + "name": "lastname", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The user's domain", + "name": "domain", "type": "string" }, + {}, { - "description": "The user's lastname", - "name": "lastname", + "description": "The user's firstname", + "name": "firstname", "type": "string" }, { - "description": "The user's firstname", - "name": "firstname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The user's email", + "name": "email", + "type": "string" } ], "since": "4.3.0" @@ -86257,17 +86482,17 @@ "name": "moveDomain", "params": [ { - "description": "The ID of the new parent domain of the domain to be moved.", + "description": "The ID of the domain to be moved.", "length": 255, - "name": "parentdomainid", + "name": "domainid", "related": "createDomain,listDomains,listDomains,moveDomain", "required": true, "type": "uuid" }, { - "description": "The ID of the domain to be moved.", + "description": "The ID of the new parent domain of the domain to be moved.", "length": 255, - "name": "domainid", + "name": "parentdomainid", "related": "createDomain,listDomains,listDomains,moveDomain", "required": true, "type": "uuid" @@ -86276,18 +86501,19 @@ "related": "createDomain,listDomains,listDomains", "response": [ { - "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 total number of networks the domain can own", - "name": "networklimit", + "description": "the path of the domain", + "name": "path", "type": "string" }, { - "description": "the total number of cpu cores available to be created for this domain", - "name": "cpuavailable", + "description": "the state of the domain", + "name": "state", "type": "string" }, { @@ -86296,14 +86522,14 @@ "type": "string" }, { - "description": "the total volume available for this domain", - "name": "volumeavailable", - "type": "string" + "description": "whether the domain has one or more sub-domains", + "name": "haschild", + "type": "boolean" }, { - "description": "the total number of backups stored by this domain", - "name": "backuptotal", - "type": "long" + "description": "the total memory (in MB) available to be created for this domain", + "name": "memoryavailable", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", @@ -86311,8 +86537,8 @@ "type": "integer" }, { - "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" }, { @@ -86321,58 +86547,53 @@ "type": "string" }, { - "description": "the total object storage space (in GiB) the domain can own", - "name": "objectstoragelimit", + "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", - "type": "long" - }, - { - "description": "the total secondary storage space (in GiB) owned by domain", - "name": "secondarystoragetotal", - "type": "float" + "description": "the total number of vpcs available to be created for this domain", + "name": "vpcavailable", + "type": "string" }, { - "description": "the total number of gpus the domain can own", - "name": "gpulimit", + "description": "the total number of snapshots which can be stored by this domain", + "name": "snapshotlimit", "type": "string" }, { - "description": "the total number of buckets stored by this domain", - "name": "buckettotal", - "type": "long" + "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 volume being used by this domain", + "name": "volumetotal", + "type": "long" }, { - "description": "the total number of buckets which can be stored by this domain", - "name": "bucketlimit", - "type": "string" + "description": "The tagged resource limit and count for the domain", + "name": "taggedresources", + "type": "list" }, { - "description": "the level of the domain", - "name": "level", - "type": "integer" + "description": "the total primary storage space (in GiB) owned by domain", + "name": "primarystoragetotal", + "type": "long" }, { - "description": "the total number of public ip addresses this domain can acquire", - "name": "iplimit", + "description": "the total number of backups available to this domain", + "name": "backupavailable", "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) available to the domain", + "name": "backupstorageavailable", "type": "string" }, { - "description": "the total volume being used by this domain", - "name": "volumetotal", + "description": "the total backup storage space (in GiB) owned by the domain", + "name": "backupstoragetotal", "type": "long" }, { @@ -86380,40 +86601,35 @@ "name": "templateavailable", "type": "string" }, - { - "description": "the total number of public ip addresses allocated for this domain", - "name": "iptotal", - "type": "long" - }, - { - "description": "the total backup storage space (in GiB) owned by the domain", - "name": "backupstoragetotal", - "type": "long" - }, { "description": "the total number of networks owned by domain", "name": "networktotal", "type": "long" }, { - "description": "the total number of gpus owned by domain", - "name": "gputotal", + "description": "the total primary storage space (in GiB) available to be used for this domain", + "name": "primarystorageavailable", + "type": "string" + }, + { + "description": "the total number of virtual machines deployed by this domain", + "name": "vmtotal", "type": "long" }, { - "description": "the domain ID of the parent domain", - "name": "parentdomainid", + "description": "the total number of public ip addresses available for this domain to acquire", + "name": "ipavailable", "type": "string" }, { - "description": "the total number of vpcs the domain can own", - "name": "vpclimit", - "type": "string" + "description": "the total number of vpcs owned by domain", + "name": "vpctotal", + "type": "long" }, { - "description": "the total backup storage space (in GiB) the domain can own", - "name": "backupstoragelimit", - "type": "string" + "description": "the total secondary storage space (in GiB) owned by domain", + "name": "secondarystoragetotal", + "type": "float" }, { "description": "Base64 string representation of the resource icon", @@ -86421,13 +86637,8 @@ "type": "resourceiconresponse" }, { - "description": "the total secondary storage space (in GiB) the domain can own", - "name": "secondarystoragelimit", - "type": "string" - }, - { - "description": "the network domain", - "name": "networkdomain", + "description": "the name of the domain", + "name": "name", "type": "string" }, { @@ -86436,38 +86647,53 @@ "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 number of backups stored by this domain", + "name": "backuptotal", + "type": "long" + }, { "description": "the total number of cpu cores owned by domain", "name": "cputotal", "type": "long" }, { - "description": "the domain name of the parent domain", - "name": "parentdomainname", + "description": "the total memory (in MB) owned by domain", + "name": "memorytotal", + "type": "long" + }, + { + "description": "the total number of gpus available to be created for this domain", + "name": "gpuavailable", "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by domain", - "name": "primarystoragetotal", - "type": "long" + "description": "the total number of templates which can be created by this domain", + "name": "templatelimit", + "type": "string" }, { - "description": "the total number of public ip addresses available for this domain to acquire", - "name": "ipavailable", + "description": "the total secondary storage space (in GiB) the domain can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "the total number of cpu cores the domain can own", - "name": "cpulimit", + "description": "the domain ID of the parent domain", + "name": "parentdomainid", "type": "string" }, { - "description": "the total primary storage space (in GiB) available to be used for this domain", - "name": "primarystorageavailable", + "description": "the total number of templates which have been created by this domain", + "name": "templatetotal", + "type": "long" + }, + { + "description": "the total number of cpu cores the domain can own", + "name": "cpulimit", "type": "string" }, { @@ -86476,8 +86702,8 @@ "type": "long" }, { - "description": "the total object storage space (in GiB) available to the domain", - "name": "objectstorageavailable", + "description": "the total memory (in MB) the domain can own", + "name": "memorylimit", "type": "string" }, { @@ -86486,40 +86712,29 @@ "type": "string" }, { - "description": "the total number of vpcs owned by domain", - "name": "vpctotal", + "description": "the total number of public ip addresses allocated for this domain", + "name": "iptotal", "type": "long" }, { - "description": "the total memory (in MB) available to be created for this domain", - "name": "memoryavailable", - "type": "string" + "description": "the total object storage space (in GiB) owned by the domain", + "name": "objectstoragetotal", + "type": "long" }, { - "description": "the total number of backups which can be stored by this domain", - "name": "backuplimit", + "description": "the total number of virtual machines that can be deployed by this domain", + "name": "vmlimit", "type": "string" }, - {}, { - "description": "the total number of virtual machines available for this domain to acquire", - "name": "vmavailable", + "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": "whether the domain has one or more sub-domains", - "name": "haschild", - "type": "boolean" - }, - { - "description": "the total number of virtual machines deployed by this domain", - "name": "vmtotal", - "type": "long" + "description": "the network domain", + "name": "networkdomain", + "type": "string" }, { "description": "the total number of snapshots stored by this domain", @@ -86527,90 +86742,100 @@ "type": "long" }, { - "description": "the total number of virtual machines that can be deployed by this domain", - "name": "vmlimit", + "description": "the total number of gpus the domain can own", + "name": "gpulimit", "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 name of the domain", - "name": "name", - "type": "string" + "description": "the date when this domain was created", + "name": "created", + "type": "date" }, { - "description": "the total number of templates which can be created by this domain", - "name": "templatelimit", + "description": "the total object storage space (in GiB) available to the domain", + "name": "objectstorageavailable", "type": "string" }, { - "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 snapshots which can be stored by this domain", - "name": "snapshotlimit", + "description": "the total number of buckets available to this domain", + "name": "bucketavailable", "type": "string" }, { - "description": "the total memory (in MB) owned by domain", - "name": "memorytotal", + "description": "the total number of gpus owned by domain", + "name": "gputotal", "type": "long" }, { - "description": "the total memory (in MB) the domain can own", - "name": "memorylimit", + "description": "the ID of the domain", + "name": "id", "type": "string" }, { - "description": "the ID of the domain", - "name": "id", + "description": "the total backup storage space (in GiB) the domain can own", + "name": "backupstoragelimit", "type": "string" }, { - "description": "The tagged resource limit and count for the domain", - "name": "taggedresources", - "type": "list" + "description": "the total number of buckets stored by this domain", + "name": "buckettotal", + "type": "long" }, { - "description": "the total number of snapshots available for this domain", - "name": "snapshotavailable", + "description": "the total number of public ip addresses this domain can acquire", + "name": "iplimit", "type": "string" }, { - "description": "the total number of gpus available to be created for this domain", - "name": "gpuavailable", + "description": "the total volume available for this domain", + "name": "volumeavailable", "type": "string" }, { - "description": "the state of the domain", - "name": "state", + "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", + "description": "the level of the domain", + "name": "level", + "type": "integer" + }, + { + "description": "details for the domain", + "name": "domaindetails", + "type": "map" + }, + { + "description": "the total number of backups which can be stored by this domain", + "name": "backuplimit", "type": "string" }, { - "description": "the path of the domain", - "name": "path", + "description": "the total number of networks the domain can own", + "name": "networklimit", "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 number of buckets which can be stored by this domain", + "name": "bucketlimit", + "type": "string" } ], "since": "4.19.0.0" @@ -86621,146 +86846,121 @@ "name": "listNetworks", "params": [ { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", - "length": 255, - "name": "listall", - "required": false, - "type": "boolean" - }, - { - "description": "list only resources belonging to the domain specified", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains", - "required": false, - "type": "uuid" - }, - { - "description": "list networks by network offering ID", + "description": "the zone ID of the network", "length": 255, - "name": "networkofferingid", - "related": "createNetworkOffering,updateNetworkOffering,listNetworkOfferings", + "name": "zoneid", + "related": "listZones", "required": false, "type": "uuid" }, { - "description": "possible values are \"account\", \"domain\", \"accountdomain\",\"shared\", and \"all\". Default value is \"all\".* account : account networks that have been registered for or created by the calling user. * domain : domain networks that have been registered for or created by the calling user. * accountdomain : account and domain networks that have been registered for or created by the calling user. * shared : networks that have been granted to the calling user by another user. * all : all networks (account, domain and shared).", - "length": 255, - "name": "networkfilter", - "required": false, - "since": "4.17.0", - "type": "string" - }, - { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "list networks available for VM deployment", "length": 255, - "name": "displaynetwork", + "name": "canusefordeploy", "required": false, - "since": "4.4", "type": "boolean" }, { - "description": "list networks by ID", + "description": "true if need to list only networks which support specifying IP ranges", "length": 255, - "name": "id", - "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", + "name": "specifyipranges", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "true if network is system, false otherwise", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "issystem", + "name": "tags", "required": false, - "type": "boolean" + "type": "map" }, { - "description": "the network belongs to VPC", + "description": "", "length": 255, - "name": "forvpc", + "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.", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources 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 networks by VPC", + "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": "vpcid", - "related": "listVPCs,createVPC,listVPCs,updateVPC", + "name": "networkfilter", "required": false, - "type": "uuid" + "since": "4.17.0", + "type": "string" }, { - "description": "List networks by associated networks. Only available if create a Shared network.", + "description": "list networks by network offering ID", "length": 255, - "name": "associatednetworkid", - "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", + "name": "networkofferingid", + "related": "createNetworkOffering,updateNetworkOffering,listNetworkOfferings", "required": false, - "since": "4.17.0", "type": "uuid" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "List by keyword", "length": 255, - "name": "account", + "name": "keyword", "required": false, "type": "string" }, { - "description": "list networks by ACL (access control list) type. Supported values are account and domain", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "acltype", + "name": "domainid", + "related": "createDomain,listDomains,listDomains", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "true if need to list only networks which support specifying IP ranges", + "description": "", "length": 255, - "name": "specifyipranges", + "name": "page", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "the ID or VID of the network", + "description": "type of the traffic", "length": 255, - "name": "vlan", + "name": "traffictype", "required": false, - "since": "4.17.0", "type": "string" }, { - "description": "type of the traffic", + "description": "list networks by name", "length": 255, - "name": "traffictype", + "name": "name", "required": false, + "since": "4.22.0", "type": "string" }, { - "description": "List resources by tags (key/value pairs)", + "description": "the network belongs to VPC", "length": 255, - "name": "tags", + "name": "forvpc", "required": false, - "type": "map" + "type": "boolean" }, { - "description": "makes the API's response contains only the resource count", + "description": "true if network is system, false otherwise", "length": 255, - "name": "retrieveonlyresourcecount", + "name": "issystem", "required": false, "type": "boolean" }, { - "description": "List by keyword", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "keyword", + "name": "isrecursive", "required": false, - "type": "string" + "type": "boolean" }, { "description": "list objects by project; if projectid=-1 lists All VMs", @@ -86771,18 +86971,27 @@ "type": "uuid" }, { - "description": "the type of the network. Supported values are: isolated, l2, shared and all", + "description": "the ID or VID of the network", "length": 255, - "name": "type", + "name": "vlan", "required": false, + "since": "4.17.0", "type": "string" }, { - "description": "flag to display the resource icon for networks", + "description": "List networks by VPC", "length": 255, - "name": "showicon", + "name": "vpcid", + "related": "listVPCs,createVPC,listVPCs,updateVPC", "required": false, - "type": "boolean" + "type": "uuid" + }, + { + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, + "type": "string" }, { "description": "list networks by physical network id", @@ -86793,40 +87002,49 @@ "type": "uuid" }, { - "description": "list networks available for VM deployment", + "description": "flag to display the resource icon for networks", "length": 255, - "name": "canusefordeploy", + "name": "showicon", "required": false, "type": "boolean" }, { - "description": "the zone ID of the network", + "description": "list networks by ACL (access control list) type. Supported values are account and domain", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "acltype", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "", + "description": "list networks supporting certain services", "length": 255, - "name": "pagesize", + "name": "supportedservices", "required": false, - "type": "integer" + "type": "list" }, { - "description": "list networks supporting certain services", + "description": "list networks by ID", "length": 255, - "name": "supportedservices", + "name": "id", + "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", "required": false, - "type": "list" + "type": "uuid" }, { - "description": "", + "description": "makes the API's response contains only the resource count", "length": 255, - "name": "page", + "name": "retrieveonlyresourcecount", "required": false, - "type": "integer" + "type": "boolean" + }, + { + "description": "List networks by associated networks. Only available if create a Shared network.", + "length": 255, + "name": "associatednetworkid", + "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", + "required": false, + "since": "4.17.0", + "type": "uuid" }, { "description": "list networks by restartRequired", @@ -86834,13 +87052,28 @@ "name": "restartrequired", "required": false, "type": "boolean" + }, + { + "description": "the type of the network. Supported values are: isolated, l2, shared and all", + "length": 255, + "name": "type", + "required": false, + "type": "string" + }, + { + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "length": 255, + "name": "displaynetwork", + "required": false, + "since": "4.4", + "type": "boolean" } ], "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", "response": [ { - "description": "the first IPv6 DNS for the network", - "name": "ip6dns1", + "description": "the id of the network", + "name": "id", "type": "string" }, { @@ -86849,54 +87082,50 @@ "type": "map" }, { - "description": "path of the Domain the network belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the first IPv4 DNS for the network", - "name": "dns1", + "description": "ACL Id associated with the VPC network", + "name": "aclid", "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 vlan of the network. This parameter is visible to ROOT admins only", + "name": "vlan", "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": "The Ipv6 routing type of network offering", + "name": "ip6routing", "type": "string" }, + {}, { - "description": "true if network is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" }, { - "description": "The vlan of the network. This parameter is visible to ROOT admins only", - "name": "vlan", + "description": "related to what other network configuration", + "name": "related", "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": "if network offering supports vm autoscaling feature", - "name": "supportsvmautoscaling", - "type": "boolean" + "description": "the physical network id", + "name": "physicalnetworkid", + "type": "string" }, { "description": "the network's gateway", @@ -86904,34 +87133,48 @@ "type": "string" }, { - "description": "list networks available for vm deployment", - "name": "canusefordeploy", + "description": "Tungsten-Fabric virtual router the network belongs to", + "name": "tungstenvirtualrouteruuid", + "type": "string" + }, + { + "description": "true if network is system, false otherwise", + "name": "issystem", "type": "boolean" }, { - "description": "the type of the network", - "name": "type", + "description": "the network's netmask", + "name": "netmask", "type": "string" }, { - "description": "ACL Id associated with the VPC network", - "name": "aclid", + "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", + "name": "zonesnetworkspans", + "type": "set" + }, + { + "description": "the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE", + "name": "networkcidr", "type": "string" }, { - "description": "the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes", - "name": "reservediprange", + "description": "list networks available for vm deployment", + "name": "canusefordeploy", + "type": "boolean" + }, + { + "description": "Name of the VPC to which this network belongs", + "name": "vpcname", "type": "string" }, { - "description": "display text of the network offering the network is created from", - "name": "networkofferingdisplaytext", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, - {}, { - "description": "the network domain", - "name": "networkdomain", + "description": "availability of the network offering the network is created from", + "name": "networkofferingavailability", "type": "string" }, { @@ -86940,48 +87183,43 @@ "type": "long" }, { - "description": "state of the network", - "name": "state", - "type": "string" - }, - { - "description": "the physical network id", - "name": "physicalnetworkid", + "description": "the type of the network", + "name": "type", "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": "MTU configured on the network VR's public facing interfaces", - "name": "publicmtu", - "type": "integer" + "description": "the domain id of the network owner", + "name": "domainid", + "type": "string" }, { - "description": "Tungsten-Fabric virtual router the network belongs to", - "name": "tungstenvirtualrouteruuid", + "description": "The internet protocol of network offering", + "name": "internetprotocol", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "Broadcast domain type of the network", + "name": "broadcastdomaintype", + "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": "acl type - access type to the network", + "name": "acltype", "type": "string" }, { - "description": "the name of the zone the network belongs to", - "name": "zonename", + "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 owner of the network", - "name": "account", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { @@ -86992,11 +87230,6 @@ "description": "the list of capabilities", "name": "capability", "response": [ - { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" - }, { "description": "the capability value", "name": "value", @@ -87006,6 +87239,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" @@ -87015,38 +87253,38 @@ "name": "provider", "response": [ { - "description": "services for this provider", - "name": "servicelist", - "type": "list" + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" }, { - "description": "uuid of the network provider", - "name": "id", + "description": "the provider name", + "name": "name", "type": "string" }, { - "description": "state of the network provider", - "name": "state", + "description": "uuid of the network provider", + "name": "id", "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", "type": "string" }, { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", + "description": "state of the network provider", + "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 provider name", - "name": "name", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" } ], @@ -87061,191 +87299,113 @@ "type": "list" }, { - "description": "true network requires restart", - "name": "restartrequired", + "description": "true if network supports specifying ip ranges, false otherwise", + "name": "specifyipranges", "type": "boolean" }, { - "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 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": "AS NUMBER", + "name": "asnumber", + "type": "long" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "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": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", "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": "true if users from subdomains can access the domain level network", + "name": "subdomainaccess", + "type": "boolean" }, - {}, { - "description": "If the network has redundant routers enabled", - "name": "redundantrouter", + "description": "if network offering supports vm autoscaling feature", + "name": "supportsvmautoscaling", "type": "boolean" }, { - "description": "VPC the network belongs to", - "name": "vpcid", + "description": "the domain name of the network owner", + "name": "domain", "type": "string" }, { - "description": "true if network is system, false otherwise", - "name": "issystem", - "type": "boolean" + "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", + "name": "broadcasturi", + "type": "string" }, { - "description": "AS NUMBER", - "name": "asnumber", - "type": "long" + "description": "the first IPv6 DNS for the network", + "name": "ip6dns1", + "type": "string" }, { - "description": "true if network offering is ip conserve mode enabled", - "name": "networkofferingconservemode", - "type": "boolean" + "description": "the network domain", + "name": "networkdomain", + "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 IPv4 DNS for the network", + "name": "dns2", + "type": "string" }, { - "description": "MTU configured on the network VR's private interfaces", - "name": "privatemtu", - "type": "integer" + "description": "ACL name associated with the VPC network", + "name": "aclname", + "type": "string" }, { - "description": "availability of the network offering the network is created from", - "name": "networkofferingavailability", + "description": "zone id of the network", + "name": "zoneid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "The BGP peers for the network", + "name": "bgppeers", + "type": "set" }, { - "description": "The internet protocol of network offering", - "name": "internetprotocol", + "description": "state of the network", + "name": "state", "type": "string" }, { - "description": "Name of the VPC to which this network belongs", - "name": "vpcname", + "description": "network offering id the network is created from", + "name": "networkofferingid", "type": "string" }, { - "description": "the 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", + "description": "the first IPv4 DNS for the network", + "name": "dns1", "type": "string" }, { "description": "The routes for the network to ease adding route in upstream router", - "name": "ip6routes", + "name": "ip4routes", "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 name of the zone the network belongs to", + "name": "zonename", "type": "string" }, { - "description": "UUID of AS NUMBER", - "name": "asnumberid", - "type": "string" + "description": "MTU configured on the network VR's public facing interfaces", + "name": "publicmtu", + "type": "integer" }, { - "description": "network offering id the network is created from", - "name": "networkofferingid", + "description": "The IPv4 routing type of network", + "name": "ip4routing", "type": "string" }, { @@ -87254,63 +87414,126 @@ "type": "string" }, { - "description": "the id of the network", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the ID of the Network associated with this private gateway", - "name": "associatednetworkid", + "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 list of resource tags associated with network", + "name": "tags", + "response": [ + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "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": "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": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "list networks that are persistent", + "name": "ispersistent", + "type": "boolean" + }, + { + "description": "UUID of AS NUMBER", + "name": "asnumberid", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the owner of the network", + "name": "account", "type": "string" }, { - "description": "an optional field, whether to the display the network to the end user or not.", - "name": "displaynetwork", + "description": "If the network has redundant routers enabled", + "name": "redundantrouter", "type": "boolean" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "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": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", - "name": "cidr", + "description": "path of the Domain the network belongs to", + "name": "domainpath", "type": "string" }, + {}, { - "description": "zone id of the network", - "name": "zoneid", + "description": "the ID of the Network associated with this private gateway", + "name": "associatednetworkid", "type": "string" }, { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip4routes", - "type": "set" - }, - { - "description": "The external id of the network", - "name": "externalid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the traffic type of the network", - "name": "traffictype", + "description": "VPC the network belongs to", + "name": "vpcid", "type": "string" }, { @@ -87319,48 +87542,58 @@ "type": "boolean" }, { - "description": "list networks that are persistent", - "name": "ispersistent", + "description": "true if network offering is ip conserve mode enabled", + "name": "networkofferingconservemode", "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "true network requires restart", + "name": "restartrequired", + "type": "boolean" }, { - "description": "the name of the network", - "name": "name", - "type": "string" + "description": "the date this network was created", + "name": "created", + "type": "date" }, { - "description": "true if network can span multiple zones", - "name": "strechedl2subnet", + "description": "MTU configured on the network VR's private interfaces", + "name": "privatemtu", + "type": "integer" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the network's netmask", - "name": "netmask", + "description": "the traffic type of the network", + "name": "traffictype", "type": "string" }, { - "description": "the second IPv6 DNS for the network", - "name": "ip6dns2", + "description": "true if guest network default egress policy is allow; false if default egress policy is deny", + "name": "egressdefaultpolicy", + "type": "boolean" + }, + { + "description": "name of the network offering the network is created from", + "name": "networkofferingname", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "The external id of the network", + "name": "externalid", "type": "string" }, { - "description": "true if users from subdomains can access the domain level network", - "name": "subdomainaccess", - "type": "boolean" + "description": "display text of the network offering the network is created from", + "name": "networkofferingdisplaytext", + "type": "string" }, { - "description": "the name of the Network associated with this private gateway", - "name": "associatednetwork", + "description": "the name of the network", + "name": "name", "type": "string" } ] @@ -87380,27 +87613,27 @@ } ], "response": [ + {}, {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "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" } ], "since": "4.17" @@ -87411,11 +87644,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.", @@ -87434,39 +87668,38 @@ "type": "string" }, { - "description": "UUID of POD, where the IP range belongs to.", + "description": "The new starting IP address.", "length": 255, - "name": "podid", - "related": "listPods,createManagementNetworkIpRange", - "required": true, - "type": "uuid" + "name": "newstartip", + "required": false, + "type": "string" }, { - "description": "The new starting IP address.", + "description": "The new ending IP address.", "length": 255, - "name": "newstartip", + "name": "newendip", "required": false, "type": "string" } ], "response": [ + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, {}, { "description": "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", @@ -87497,10 +87730,9 @@ ], "related": "listOsCategories", "response": [ - {}, { - "description": "the name of the OS category", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -87509,31 +87741,32 @@ "type": "boolean" }, { - "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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the OS category", + "name": "name", "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 ID of the OS category", "name": "id", "type": "string" }, { - "description": "Date when the OS category was created.", - "name": "created", - "type": "date" - }, - {} + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } ], "since": "4.21.0" }, @@ -87543,12 +87776,12 @@ "name": "updateFirewallRule", "params": [ { - "description": "the ID of the 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": "id", - "related": "listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule", - "required": true, - "type": "uuid" + "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", @@ -87559,40 +87792,40 @@ "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 firewall rule", "length": 255, - "name": "customid", - "required": false, - "since": "4.4", - "type": "string" + "name": "id", + "related": "listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule", + "required": true, + "type": "uuid" } ], "related": "createFirewallRule,listFirewallRules,updateEgressFirewallRule", "response": [ { - "description": "the ID of the firewall rule", - "name": "id", - "type": "string" + "description": "error code for this icmp message", + "name": "icmpcode", + "type": "integer" }, { - "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 public ip address for the firewall rule", - "name": "ipaddress", + "description": "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).", + "name": "destcidrlist", "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": "the ending port of firewall rule's port range", - "name": "endport", - "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", @@ -87600,14 +87833,18 @@ "type": "string" }, { - "description": "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).", - "name": "destcidrlist", + "description": "the traffic type for the firewall rule", + "name": "traffictype", "type": "string" }, - {}, { - "description": "the state of the rule", - "name": "state", + "description": "the network id of the firewall rule", + "name": "networkid", + "type": "string" + }, + { + "description": "the public ip address for the firewall rule", + "name": "ipaddress", "type": "string" }, { @@ -87615,38 +87852,38 @@ "name": "tags", "response": [ { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag key name", + "name": "key", "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": "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": "the domain associated with the tag", - "name": "domain", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -87655,42 +87892,39 @@ "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": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" } ], "type": "list" }, - { - "description": "the traffic type for the firewall rule", - "name": "traffictype", - "type": "string" - }, { "description": "is rule for display to the regular user", "name": "fordisplay", "type": "boolean" }, + {}, + {}, { - "description": "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 public ip address id for the firewall rule", - "name": "ipaddressid", - "type": "string" + "description": "the ending port of firewall rule's port range", + "name": "endport", + "type": "integer" }, { "description": "type of the icmp message being sent", @@ -87698,19 +87932,18 @@ "type": "integer" }, { - "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", + "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", + "description": "the protocol of the firewall rule", + "name": "protocol", "type": "string" } ], @@ -87723,23 +87956,23 @@ "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,6 +87991,8 @@ } ], "response": [ + {}, + {}, { "description": "true if operation is executed successfully", "name": "success", @@ -87777,9 +88012,7 @@ "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" - }, - {}, - {} + } ], "since": "4.19.0" }, @@ -87796,18 +88029,18 @@ "type": "integer" }, { - "description": "List by type of the quota email template, allowed types: QUOTA_LOW, QUOTA_EMPTY", + "description": "", "length": 255, - "name": "templatetype", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "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", @@ -87819,16 +88052,6 @@ ], "related": "", "response": [ - { - "description": "Last date/time when template was updated", - "name": "last_updated", - "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", @@ -87836,13 +88059,13 @@ }, {}, { - "description": "The quota email template locale", - "name": "locale", + "description": "The quota email template content", + "name": "templatebody", "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" }, { @@ -87850,12 +88073,22 @@ "name": "templatetype", "type": "string" }, - {}, { - "description": "The quota email template content", - "name": "templatebody", + "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 quota email template locale", + "name": "locale", + "type": "string" + }, + {} ], "since": "4.7.0" }, @@ -87865,11 +88098,11 @@ "name": "createBgpPeer", "params": [ { - "description": "The password of the Bgp Peer.", + "description": "BGP peer details in key/value pairs.", "length": 255, - "name": "password", + "name": "details", "required": false, - "type": "string" + "type": "map" }, { "description": "account who will own the Bgp Peer", @@ -87878,6 +88111,14 @@ "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": "The IPv4 address of the Bgp Peer.", "length": 255, @@ -87886,20 +88127,19 @@ "type": "string" }, { - "description": "domain ID of the account owning the Bgp Peer", + "description": "UUID of the zone which the Bgp Peer belongs to.", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains", - "required": false, + "name": "zoneid", + "related": "listZones", + "required": true, "type": "uuid" }, { - "description": "project who will own the Bgp Peer", + "description": "The AS number of the Bgp Peer.", "length": 255, - "name": "projectid", - "related": "createProject", - "required": false, - "type": "uuid" + "name": "asnumber", + "required": true, + "type": "long" }, { "description": "The IPv6 address of the Bgp Peer.", @@ -87909,73 +88149,67 @@ "type": "string" }, { - "description": "BGP peer details in key/value pairs.", + "description": "The password of the Bgp Peer.", "length": 255, - "name": "details", + "name": "password", "required": false, - "type": "map" + "type": "string" }, { - "description": "UUID of the zone which the Bgp Peer belongs to.", + "description": "project who will own the Bgp Peer", "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, + "name": "projectid", + "related": "createProject", + "required": false, "type": "uuid" - }, - { - "description": "The AS number of the Bgp Peer.", - "length": 255, - "name": "asnumber", - "required": true, - "type": "long" } ], "related": "listBgpPeers,dedicateBgpPeer,releaseBgpPeer", "response": [ + {}, { - "description": "the project id of the bgp peer", - "name": "projectid", + "description": "id of the bgp peer", + "name": "id", "type": "string" }, { - "description": "IPv6 address of bgp peer", - "name": "ip6address", + "description": "password of bgp peer", + "name": "password", "type": "string" }, { - "description": "name of zone to which the bgp peer belongs to.", - "name": "zonename", + "description": "IPv4 address of bgp peer", + "name": "ipaddress", "type": "string" }, { - "description": "id of the bgp peer", - "name": "id", + "description": "the project name of the bgp peer", + "name": "project", "type": "string" }, { - "description": "id of zone to which the bgp peer belongs to.", - "name": "zoneid", + "description": "IPv6 address of bgp peer", + "name": "ip6address", "type": "string" }, { - "description": "the account of the bgp peer", - "name": "account", - "type": "string" + "description": "AS number of bgp peer", + "name": "asnumber", + "type": "long" }, { - "description": "the project name of the bgp peer", - "name": "project", + "description": "the project id of the bgp peer", + "name": "projectid", "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": "IPv4 address of bgp peer", - "name": "ipaddress", + "description": "name of zone to which the bgp peer belongs to.", + "name": "zonename", "type": "string" }, { @@ -87984,8 +88218,13 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "additional key/value details of the bgp peer", + "name": "details", + "type": "map" + }, + { + "description": "id of zone to which the bgp peer belongs to.", + "name": "zoneid", "type": "string" }, { @@ -87998,18 +88237,12 @@ "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 account of the bgp peer", + "name": "account", + "type": "string" }, - {}, { "description": "date when this bgp peer was created.", "name": "created", @@ -88034,22 +88267,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": "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" } ] }, @@ -88058,14 +88291,6 @@ "isasync": true, "name": "dedicateBgpPeer", "params": [ - { - "description": "Id of the Bgp Peer", - "length": 255, - "name": "id", - "related": "listBgpPeers,dedicateBgpPeer,releaseBgpPeer", - "required": true, - "type": "uuid" - }, { "description": "project who will own the Bgp Peer", "length": 255, @@ -88074,6 +88299,13 @@ "required": false, "type": "uuid" }, + { + "description": "account who will own the Bgp Peer", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, { "description": "domain ID of the account owning the Bgp Peer", "length": 255, @@ -88083,96 +88315,97 @@ "type": "uuid" }, { - "description": "account who will own the Bgp Peer", + "description": "Id of the Bgp Peer", "length": 255, - "name": "account", - "required": false, - "type": "string" + "name": "id", + "related": "listBgpPeers,dedicateBgpPeer,releaseBgpPeer", + "required": true, + "type": "uuid" } ], "related": "listBgpPeers,releaseBgpPeer", "response": [ - { - "description": "additional key/value details of the bgp peer", - "name": "details", - "type": "map" - }, { "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": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the project name of the bgp peer", - "name": "project", + "description": "id of the bgp peer", + "name": "id", "type": "string" }, {}, { - "description": "id of zone to which the bgp peer belongs to.", - "name": "zoneid", + "description": "IPv4 address of bgp peer", + "name": "ipaddress", "type": "string" }, { - "description": "id of the bgp peer", - "name": "id", + "description": "IPv6 address of bgp peer", + "name": "ip6address", "type": "string" }, { - "description": "IPv4 address of bgp peer", - "name": "ipaddress", - "type": "string" + "description": "date when this bgp peer was created.", + "name": "created", + "type": "date" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project name of the bgp peer", + "name": "project", "type": "string" }, + {}, { - "description": "IPv6 address of bgp peer", - "name": "ip6address", + "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": "AS number of bgp peer", - "name": "asnumber", - "type": "long" + "description": "the project id of the bgp peer", + "name": "projectid", + "type": "string" }, { - "description": "the domain ID of the bgp peer", - "name": "domainid", + "description": "the account of the bgp peer", + "name": "account", "type": "string" }, { - "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": "AS number of bgp peer", + "name": "asnumber", + "type": "long" + }, + { + "description": "the domain ID of the bgp peer", + "name": "domainid", + "type": "string" }, { "description": "name of zone to which the bgp peer belongs to.", "name": "zonename", "type": "string" + }, + { + "description": "additional key/value details of the bgp peer", + "name": "details", + "type": "map" } ], "since": "4.20.0" @@ -88183,85 +88416,84 @@ "name": "listHostsMetrics", "params": [ { - "description": "", + "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": "pagesize", + "name": "resourcestate", "required": false, - "type": "integer" + "type": "string" }, { - "description": "hypervisor type of host: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator", + "description": "the id of the management server", "length": 255, - "name": "hypervisor", + "name": "managementserverid", + "related": "listManagementServers", "required": false, - "type": "string" + "since": "4.21.0", + "type": "uuid" }, { - "description": "the id of the host", + "description": "the Zone ID for the host", "length": 255, - "name": "id", - "related": "declareHostAsDegraded,reconnectHost", + "name": "zoneid", + "related": "listZones", "required": false, "type": "uuid" }, { - "description": "the state of the host", + "description": "if true, list only hosts dedicated to HA", "length": 255, - "name": "state", + "name": "hahost", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "the host type", + "description": "List by keyword", "length": 255, - "name": "type", + "name": "keyword", "required": false, "type": "string" }, { - "description": "the Zone ID for the host", + "description": "", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "if true, list only hosts dedicated to HA", + "description": "the id of the host", "length": 255, - "name": "hahost", + "name": "id", + "related": "declareHostAsDegraded,reconnectHost", "required": false, - "type": "boolean" + "type": "uuid" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "lists hosts existing in particular cluster", + "description": "the state of the host", "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", + "name": "state", "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": "list hosts by its out-of-band management interface's power state. Its value can be one of [On, Off, Unknown]", "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": "outofbandmanagementpowerstate", "required": false, - "type": "uuid" + "type": "string" }, { - "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" }, { @@ -88273,17 +88505,27 @@ "type": "string" }, { - "description": "list hosts by its out-of-band management interface's power state. Its value can be one of [On, Off, Unknown]", + "description": "the Pod ID for the host", "length": 255, - "name": "outofbandmanagementpowerstate", + "name": "podid", + "related": "listPods,createManagementNetworkIpRange", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "list hosts by resource state. Resource state represents current state determined by admin of host, value can be one of [Enabled, Disabled, Unmanaged, PrepareForMaintenance, ErrorInMaintenance, Maintenance, Error]", + "description": "lists hosts existing in particular cluster", "length": 255, - "name": "resourcestate", + "name": "clusterid", + "related": "addCluster,updateCluster", + "required": false, + "type": "uuid" + }, + { + "description": "the name of the storage access group", + "length": 255, + "name": "storageaccessgroup", "required": false, + "since": "4.21.0", "type": "string" }, { @@ -88294,14 +88536,20 @@ "type": "string" }, { - "description": "the id of the management server", + "description": "lists hosts in the same cluster as this VM and flag hosts with enough CPU/RAm to host this VM", "length": 255, - "name": "managementserverid", - "related": "listManagementServers", + "name": "virtualmachineid", + "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,createVMFromBackup,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "required": false, - "since": "4.21.0", "type": "uuid" }, + { + "description": "hypervisor type of host: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator", + "length": 255, + "name": "hypervisor", + "required": false, + "type": "string" + }, { "description": "comma separated list of host details requested, value can be a list of [ min, all, capacity, events, stats]", "length": 255, @@ -88315,43 +88563,18 @@ "name": "outofbandmanagementenabled", "required": false, "type": "boolean" - }, - { - "description": "the Pod ID for the host", - "length": 255, - "name": "podid", - "related": "listPods,createManagementNetworkIpRange", - "required": false, - "type": "uuid" - }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" } ], "related": "", "response": [ { - "description": "the host version", - "name": "version", - "type": "string" - }, - { - "description": "true if the host has capability to support UEFI boot", - "name": "ueficapability", - "type": "boolean" - }, - { - "description": "the OS category ID of the host", - "name": "oscategoryid", - "type": "string" + "description": "the state of the host", + "name": "state", + "type": "status" }, { - "description": "the name of the host", - "name": "name", + "description": "network read in GiB", + "name": "networkread", "type": "string" }, { @@ -88360,89 +88583,73 @@ "type": "type" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" + "description": "cpu usage notification threshold exceeded", + "name": "cputhreshold", + "type": "boolean" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "true if the host supports instance conversion (using virt-v2v)", + "name": "instanceconversionsupported", + "type": "boolean" }, { - "description": "the ID of the host", - "name": "id", + "description": "the total cpu allocated in Ghz", + "name": "cpuallocatedghz", "type": "string" }, { - "description": "memory usage disable threshold exceeded", - "name": "memorydisablethreshold", - "type": "boolean" + "description": "the last time this host was annotated", + "name": "lastannotated", + "type": "date" }, { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", + "description": "memory allocated notification threshold exceeded", + "name": "memoryallocatedthreshold", "type": "boolean" }, { - "description": "the Zone ID of the host", - "name": "zoneid", - "type": "string" - }, - { - "description": "events available for the host", - "name": "events", - "type": "string" - }, - { - "description": "the total cpu allocated in Ghz", - "name": "cpuallocatedghz", - "type": "string" + "description": "the amount of the host's memory currently used", + "name": "memoryused", + "type": "long" }, { - "description": "The name of extension for this cluster", - "name": "extensionname", - "type": "string" + "description": "cpu usage disable threshold exceeded", + "name": "cpudisablethreshold", + "type": "boolean" }, { - "description": "the amount of the host's CPU currently allocated in MHz", - "name": "cpuallocatedvalue", - "type": "long" + "description": "memory usage notification threshold exceeded", + "name": "memorythreshold", + "type": "boolean" }, { - "description": "network write in GiB", - "name": "networkwrite", - "type": "string" + "description": "true if the host has capability to support UEFI boot", + "name": "ueficapability", + "type": "boolean" }, { - "description": "comma-separated list of storage access groups on the zone", - "name": "zonestorageaccessgroups", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the Zone name of the host", - "name": "zonename", + "description": "comma-separated list of storage access groups on the cluster", + "name": "clusterstorageaccessgroups", "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 after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", - "type": "string" - }, - { - "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": "comma-separated list of storage access groups on the pod", - "name": "podstorageaccessgroups", + "description": "the Zone ID of the host", + "name": "zoneid", "type": "string" }, { @@ -88451,114 +88658,80 @@ "type": "string" }, { - "description": "the total cpu used in Ghz", - "name": "cpuusedghz", - "type": "string" + "description": "true if the host supports encryption", + "name": "encryptionsupported", + "type": "boolean" }, { - "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 memory currently allocated", - "name": "memoryallocated", - "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", + "description": "instances on the host", + "name": "instances", "type": "string" }, { - "description": "the Pod ID of the host", - "name": "podid", - "type": "string" + "description": "the CPU speed of the host", + "name": "cpuspeed", + "type": "long" }, { - "description": "the total memory used in GiB", - "name": "memoryusedgb", + "description": "network write in GiB", + "name": "networkwrite", "type": "string" }, { - "description": "the IP address of the host", - "name": "ipaddress", + "description": "the total memory allocated in GiB", + "name": "memoryallocatedgb", "type": "string" }, { - "description": "cpu usage disable threshold exceeded", - "name": "cpudisablethreshold", + "description": "memory allocated disable threshold exceeded", + "name": "memoryallocateddisablethreshold", "type": "boolean" }, { - "description": "comma-separated list of storage access groups for the host", - "name": "storageaccessgroups", - "type": "string" - }, - { - "description": "the date and time the host was removed", - "name": "removed", + "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": "comma-separated list of storage access groups on the zone", + "name": "zonestorageaccessgroups", "type": "string" }, { - "description": "the management server ID of the host", - "name": "managementserverid", + "description": "the OS category ID of the host", + "name": "oscategoryid", "type": "string" }, { - "description": "the last time this host was annotated", - "name": "lastannotated", - "type": "date" - }, - { - "description": "true if the host supports encryption", - "name": "encryptionsupported", - "type": "boolean" - }, - { - "description": "Used GPUs on the Host", - "name": "gpuused", - "type": "long" - }, - { - "description": "the state of the host", - "name": "state", - "type": "status" - }, - { - "description": "comma-separated list of explicit host tags for the host", - "name": "explicithosttags", + "description": "the admin that annotated this host", + "name": "username", "type": "string" }, { - "description": "the cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" + "description": "the name of the host", + "name": "name", + "type": "string" }, { - "description": "the date and time the host was last pinged", - "name": "lastpinged", - "type": "date" + "description": "the virtual machine id for host type ConsoleProxy and SecondaryStorageVM", + "name": "virtualmachineid", + "type": "string" }, { - "description": "true if the host supports instance conversion (using virt-v2v)", - "name": "instanceconversionsupported", + "description": "cpu allocated disable threshold exceeded", + "name": "cpuallocateddisablethreshold", "type": "boolean" }, + {}, { - "description": "true if the host is disconnected. False otherwise.", - "name": "disconnected", - "type": "date" + "description": "The ID of extension for this cluster", + "name": "extensionid", + "type": "string" }, { "description": "the OS category name of the host", @@ -88566,64 +88739,39 @@ "type": "string" }, { - "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", - "type": "long" - }, - { - "description": "Host details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the amount of the host's CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", + "description": "the cluster type of the cluster that host belongs to", + "name": "clustertype", "type": "string" }, { - "description": "network read in GiB", - "name": "networkread", + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", "type": "string" }, { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", - "type": "long" - }, - { - "description": "the last annotation set on this host by an admin", - "name": "annotation", + "description": "the host hypervisor", + "name": "hypervisor", "type": "string" }, { - "description": "the amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", - "type": "string" + "description": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", + "type": "boolean" }, { - "description": "the total memory allocated in GiB", - "name": "memoryallocatedgb", + "description": "comma-separated list of tags for the host", + "name": "hosttags", "type": "string" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", + "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "name": "memorytotal", "type": "long" }, { - "description": "the admin that annotated this host", - "name": "username", - "type": "string" + "description": "the host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" }, { "description": "the management server name of the host", @@ -88636,74 +88784,49 @@ "type": "boolean" }, { - "description": "the cluster name of the host", - "name": "clustername", - "type": "string" - }, - { - "description": "cpu usage notification threshold exceeded", - "name": "cputhreshold", - "type": "boolean" - }, - { - "description": "the amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", + "description": "the amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", "type": "long" }, { - "description": "comma-separated list of implicit host tags for the host", - "name": "implicithosttags", - "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 amount of the host's CPU currently allocated", + "name": "cpuallocated", "type": "string" }, { - "description": "memory allocated notification threshold exceeded", - "name": "memoryallocatedthreshold", - "type": "boolean" + "description": "Used GPUs on the Host", + "name": "gpuused", + "type": "long" }, { - "description": "cpu allocated notification threshold exceeded", - "name": "cpuallocatedthreshold", - "type": "boolean" + "description": "Total GPUs on the Host", + "name": "gputotal", + "type": "long" }, { - "description": "the cluster ID of the host", - "name": "clusterid", + "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", "type": "string" }, { - "description": "CPU Arch of the host", - "name": "arch", + "description": "the cluster name of the host", + "name": "clustername", "type": "string" }, { - "description": "the date and time the host was created", - "name": "created", - "type": "date" - }, - { - "description": "the host hypervisor", - "name": "hypervisor", + "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", + "name": "cpuwithoverprovisioning", "type": "string" }, { - "description": "the hypervisor version", - "name": "hypervisorversion", - "type": "string" + "description": "the CPU number of the host", + "name": "cpunumber", + "type": "integer" }, { - "description": "the host HA information information", - "name": "hostha", - "type": "hostharesponse" + "description": "capabilities of the host", + "name": "capabilities", + "type": "string" }, { "description": "GPU cards present in the host", @@ -88714,13 +88837,8 @@ "name": "vgpu", "response": [ { - "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" }, { @@ -88734,14 +88852,9 @@ "type": "long" }, { - "description": "Video RAM for this vGPU type", - "name": "videoram", - "type": "long" - }, - { - "description": "Maximum Y resolution per display", - "name": "maxresolutiony", - "type": "long" + "description": "Model Name of vGPU", + "name": "vgputype", + "type": "string" }, { "description": "Maximum no. of vgpu per gpu card (pgpu)", @@ -88752,6 +88865,16 @@ "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", "name": "maxcapacity", "type": "long" + }, + { + "description": "Maximum Y resolution per display", + "name": "maxresolutiony", + "type": "long" + }, + { + "description": "Maximum X resolution per display", + "name": "maxresolutionx", + "type": "long" } ], "type": "list" @@ -88765,85 +88888,195 @@ "type": "list" }, { - "description": "comma-separated list of storage access groups on the cluster", - "name": "clusterstorageaccessgroups", + "description": "the Pod name of the host", + "name": "podname", "type": "string" }, { - "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": "Host details in key/value pairs.", + "name": "details", + "type": "map" + }, + {}, + { + "description": "out-of-band management power state", + "name": "powerstate", + "type": "powerstate" + }, + { + "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", + "name": "hasenoughcapacity", + "type": "boolean" + }, + { + "description": "events available for the host", + "name": "events", + "type": "string" + }, + { + "description": "comma-separated list of implicit host tags for the host", + "name": "implicithosttags", + "type": "string" + }, + { + "description": "the last annotation set on this host by an admin", + "name": "annotation", + "type": "string" + }, + { + "description": "The name of extension for this cluster", + "name": "extensionname", + "type": "string" + }, + { + "description": "the ID of the host", + "name": "id", + "type": "string" + }, + { + "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 ID of extension for this cluster", - "name": "extensionid", + "description": "comma-separated list of storage access groups for the host", + "name": "storageaccessgroups", "type": "string" }, { - "description": "the number of CPU sockets on the host", - "name": "cpusockets", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", - "name": "suitableformigration", + "description": "the Zone name of the host", + "name": "zonename", + "type": "string" + }, + { + "description": "the host version", + "name": "version", + "type": "string" + }, + { + "description": "the cluster ID of the host", + "name": "clusterid", + "type": "string" + }, + { + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" + }, + { + "description": "system vm instances on the host", + "name": "systeminstances", + "type": "string" + }, + { + "description": "true if the host is disconnected. False otherwise.", + "name": "disconnected", + "type": "date" + }, + { + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" + }, + { + "description": "cpu allocated notification threshold exceeded", + "name": "cpuallocatedthreshold", + "type": "boolean" + }, + { + "description": "the amount of the host's CPU currently used", + "name": "cpuused", + "type": "string" + }, + {}, + { + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" + }, + { + "description": "the total memory used in GiB", + "name": "memoryusedgb", + "type": "string" + }, + { + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", + "type": "string" + }, + { + "description": "the IP address of the host", + "name": "ipaddress", + "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 memory after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", + "description": "the total cpu used in Ghz", + "name": "cpuusedghz", "type": "string" }, - {}, { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", + "description": "comma-separated list of storage access groups on the pod", + "name": "podstorageaccessgroups", "type": "string" }, - {}, { "description": "the total cpu capacity in Ghz", "name": "cputotalghz", "type": "string" }, { - "description": "system vm instances on the host", - "name": "systeminstances", - "type": "string" - }, - { - "description": "instances on the host", - "name": "instances", + "description": "comma-separated list of explicit host tags for the host", + "name": "explicithosttags", "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 host's currently allocated disk size", - "name": "disksizeallocated", + "description": "the incoming network traffic on the host", + "name": "networkkbsread", "type": "long" }, { - "description": "comma-separated list of tags for the host", - "name": "hosttags", + "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", "type": "string" }, { - "description": "memory usage notification threshold exceeded", - "name": "memorythreshold", - "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 outgoing network traffic on the host", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "CPU Arch of the host", + "name": "arch", "type": "string" }, { @@ -88852,23 +89085,23 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the Pod ID of the host", + "name": "podid", + "type": "string" }, { - "description": "out-of-band management power state", - "name": "powerstate", - "type": "powerstate" + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" }, { - "description": "cpu allocated disable threshold exceeded", - "name": "cpuallocateddisablethreshold", - "type": "boolean" + "description": "the date and time the host was last pinged", + "name": "lastpinged", + "type": "date" }, { - "description": "memory allocated disable threshold exceeded", - "name": "memoryallocateddisablethreshold", + "description": "memory usage disable threshold exceeded", + "name": "memorydisablethreshold", "type": "boolean" } ], @@ -88889,29 +89122,100 @@ } ], "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": "Cancels a triggered shutdown", + "isasync": false, + "name": "cancelShutdown", + "params": [ + { + "description": "the id of the management server", + "length": 255, + "name": "managementserverid", + "related": "listManagementServers", + "required": true, + "type": "uuid" + } + ], + "related": "prepareForShutdown,readyForShutdown", + "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", + "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 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 state of the management server", + "name": "state", + "type": "state" + }, + { + "description": "Indicates whether maintenance has been initiated", + "name": "maintenanceinitiated", + "type": "boolean" + }, + { + "description": "The number of host agents this management server is responsible for", + "name": "agentscount", + "type": "long" + }, + {}, + { + "description": "Indicates whether CloudStack is ready to shutdown", + "name": "readyforshutdown", "type": "boolean" + }, + {}, + { + "description": "The id of the management server", + "name": "managementserverid", + "type": "string" } - ] + ], + "since": "4.19.0" }, { "description": "Lists affinity groups", @@ -88919,12 +89223,11 @@ "name": "listAffinityGroups", "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": "lists affinity groups by name", @@ -88934,11 +89237,11 @@ "type": "string" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "lists affinity groups by type", "length": 255, - "name": "isrecursive", + "name": "type", "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.", @@ -88950,7 +89253,7 @@ { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, @@ -88958,7 +89261,7 @@ "description": "lists affinity groups by virtual machine ID", "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", + "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,createVMFromBackup,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "required": false, "type": "uuid" }, @@ -88970,19 +89273,19 @@ "type": "string" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "projectid", - "related": "createProject", + "name": "domainid", + "related": "createDomain,listDomains,listDomains", "required": false, "type": "uuid" }, { - "description": "lists affinity groups by type", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "type", + "name": "isrecursive", "required": false, - "type": "string" + "type": "boolean" }, { "description": "List by keyword", @@ -88992,11 +89295,12 @@ "type": "string" }, { - "description": "", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "pagesize", + "name": "projectid", + "related": "createProject", "required": false, - "type": "integer" + "type": "uuid" }, { "description": "list the affinity group by the ID provided", @@ -89009,25 +89313,24 @@ ], "related": "createAffinityGroup", "response": [ - {}, { "description": "the account owning the affinity group", "name": "account", "type": "string" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { @@ -89035,79 +89338,20 @@ "name": "name", "type": "string" }, - { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", - "type": "list" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "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": "path of the Domain the affinity group belongs to", - "name": "domainpath", - "type": "string" - }, - {}, - { - "description": "the ID of the affinity group", - "name": "id", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - } - ] - }, - { - "description": "Cancels a triggered shutdown", - "isasync": false, - "name": "cancelShutdown", - "params": [ - { - "description": "the id of the management server", - "length": 255, - "name": "managementserverid", - "related": "listManagementServers", - "required": true, - "type": "uuid" - } - ], - "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", @@ -89115,44 +89359,33 @@ "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", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, - {}, - { - "description": "Indicates whether maintenance has been initiated", - "name": "maintenanceinitiated", - "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", + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", "type": "list" }, { - "description": "The number of host agents this management server is responsible for", - "name": "agentscount", - "type": "long" + "description": "the type of the affinity group", + "name": "type", + "type": "string" }, {}, { - "description": "The id of the management server", - "name": "managementserverid", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" - } - ], - "since": "4.19.0" + }, + { + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", + "type": "string" + }, + {} + ] }, { "description": "Register a public key in a keypair under a certain name", @@ -89160,10 +89393,10 @@ "name": "registerSSHKeyPair", "params": [ { - "description": "Public key material of the keypair", - "length": 5120, - "name": "publickey", - "required": true, + "description": "an optional account for the ssh key. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { @@ -89190,20 +89423,26 @@ "type": "string" }, { - "description": "an optional account for the ssh key. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, + "description": "Public key material of the keypair", + "length": 5120, + "name": "publickey", + "required": true, "type": "string" } ], "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, {}, { "description": "the domain id of the keypair owner", @@ -89211,29 +89450,28 @@ "type": "string" }, { - "description": "the domain name of the keypair owner", - "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": "Name of the keypair", + "name": "name", + "type": "string" }, - {}, { - "description": "Fingerprint of the public key", - "name": "fingerprint", + "description": "the domain name of the keypair owner", + "name": "domain", "type": "string" }, { - "description": "the project id of the keypair owner", - "name": "projectid", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the owner of the keypair", - "name": "account", + "description": "Fingerprint of the public key", + "name": "fingerprint", "type": "string" }, { @@ -89247,14 +89485,9 @@ "type": "string" }, { - "description": "Name of the keypair", - "name": "name", + "description": "the project id of the keypair owner", + "name": "projectid", "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" } ] }, @@ -89285,33 +89518,33 @@ "name": "message", "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": "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "The validated activation rule.", "name": "activationrule", "type": "string" }, - {} + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } ], "since": "4.20.0" }, @@ -89320,6 +89553,13 @@ "isasync": false, "name": "reserveIpAddress", "params": [ + { + "description": "the account to reserve with this IP address", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, { "description": "the ID of the domain to reserve with this IP address", "length": 255, @@ -89328,6 +89568,13 @@ "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 ID of the public IP address to reserve", "length": 255, @@ -89343,72 +89590,59 @@ "related": "createProject", "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, - "name": "account", - "required": false, - "type": "string" } ], "related": "associateIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", "response": [ { - "description": "virtual machine id the ip address is assigned to", - "name": "virtualmachineid", + "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": "whether the ip address has Firewall/PortForwarding/LoadBalancing rules defined", + "name": "hasrules", + "type": "boolean" }, { - "description": "public IP address id", - "name": "id", + "description": "VPC id the ip belongs to", + "name": "vpcid", "type": "string" }, + {}, { - "description": "is public IP portable across the zones", - "name": "isportable", - "type": "boolean" + "description": "date the public IP address was acquired", + "name": "allocated", + "type": "date" }, { - "description": "virtual machine name the ip address is assigned to", - "name": "virtualmachinename", + "description": "virtual machine (dnat) ip address (not null only for static nat Ip)", + "name": "vmipaddress", "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" }, { - "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", + "type": "boolean" }, { - "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", + "type": "string" }, { - "description": "the VLAN associated with the IP address", - "name": "vlanname", + "description": "public IP address", + "name": "ipaddress", "type": "string" }, { - "description": "VPC id the ip belongs to", - "name": "vpcid", + "description": "virtual machine type the ip address is assigned to", + "name": "virtualmachinetype", "type": "string" }, { @@ -89417,43 +89651,43 @@ "type": "string" }, { - "description": "whether the ip address has Firewall/PortForwarding/LoadBalancing rules defined", - "name": "hasrules", - "type": "boolean" + "description": "the domain the public IP address is associated with", + "name": "domain", + "type": "string" }, { - "description": "the domain ID the public IP address is associated with", - "name": "domainid", + "description": "the VLAN associated with the IP address", + "name": "vlanname", "type": "string" }, { - "description": "the account the public IP address is associated with", - "name": "account", + "description": "the name of the zone the public IP address belongs to", + "name": "zonename", "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "virtual machine id the ip address is assigned to", + "name": "virtualmachineid", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", - "type": "string" + "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": "VPC name the ip belongs to", + "name": "vpcname", "type": "string" }, { - "description": "the name of the Network where ip belongs to", - "name": "networkname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the name of the Network associated with the IP address", - "name": "associatednetworkname", + "description": "public IP address id", + "name": "id", "type": "string" }, { @@ -89462,8 +89696,8 @@ "type": "string" }, { - "description": "the ID of the Network where ip belongs to", - "name": "networkid", + "description": "the account the public IP address is associated with", + "name": "account", "type": "string" }, { @@ -89471,36 +89705,41 @@ "name": "issystem", "type": "boolean" }, + {}, { - "description": "virtual machine display name the ip address is assigned to (not null only for static nat Ip)", - "name": "virtualmachinedisplayname", + "description": "path of the domain to which the public IP address belongs", + "name": "domainpath", "type": "string" }, { - "description": "virtual machine type the ip address is assigned to", - "name": "virtualmachinetype", + "description": "the ID of the VLAN associated with the IP address. This parameter is visible to ROOT admins only", + "name": "vlanid", "type": "string" }, - {}, { - "description": "virtual machine (dnat) ip address (not null only for static nat Ip)", - "name": "vmipaddress", - "type": "string" + "description": "true if range is dedicated for external network providers", + "name": "forprovider", + "type": "boolean" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if this ip is for static nat, false otherwise", + "name": "isstaticnat", "type": "boolean" }, { - "description": "VPC name the ip belongs to", - "name": "vpcname", + "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": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the name of the Network associated with the IP address", + "name": "associatednetworkname", + "type": "string" }, { "description": "the virtual network for the IP address", @@ -89508,34 +89747,43 @@ "type": "boolean" }, { - "description": "true if this ip is for static nat, false otherwise", - "name": "isstaticnat", - "type": "boolean" + "description": "the ID of the Network where ip belongs to", + "name": "networkid", + "type": "string" }, { - "description": "the ID of the Network associated with the IP address", - "name": "associatednetworkid", + "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": "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": "the domain ID the public IP address is associated with", + "name": "domainid", + "type": "string" }, { - "description": "path of the domain to which the public IP address belongs", - "name": "domainpath", + "description": "virtual machine name the ip address is assigned to", + "name": "virtualmachinename", "type": "string" }, - {}, { - "description": "the ID of the zone the public IP address belongs to", - "name": "zoneid", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { @@ -89543,18 +89791,23 @@ "name": "tags", "response": [ { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "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" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -89573,51 +89826,31 @@ "type": "string" }, { - "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": "the project name where tag belongs to", - "name": "project", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "tag value", - "name": "value", + "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" } ], "type": "list" }, { - "description": "public IP address", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the name of the zone the public IP address belongs to", - "name": "zonename", - "type": "string" - }, - { - "description": "the ID of the VLAN associated with the IP address. This parameter is visible to ROOT admins only", - "name": "vlanid", - "type": "string" - }, - { - "description": "State of the ip address. Can be: Allocating, Allocated, Releasing, Reserved and Free", - "name": "state", + "description": "the ID of the zone the public IP address belongs to", + "name": "zoneid", "type": "string" } ], @@ -89629,41 +89862,38 @@ "name": "deleteEvents", "params": [ { - "description": "delete by event type", + "description": "the IDs of the events", "length": 255, - "name": "type", + "name": "ids", + "related": "", "required": false, - "type": "string" + "type": "list" }, { - "description": "end date range to delete events (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")", + "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": "enddate", + "name": "startdate", "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\")", + "description": "delete by event type", "length": 255, - "name": "startdate", + "name": "type", "required": false, - "type": "date" + "type": "string" }, { - "description": "the IDs of the events", + "description": "end 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": "ids", - "related": "", + "name": "enddate", "required": false, - "type": "list" + "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", @@ -89674,13 +89904,16 @@ "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" - }, - {} + } ] }, { @@ -89689,45 +89922,45 @@ "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 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" - } + {} ] }, { @@ -89743,20 +89976,11 @@ "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "list VPC offerings available for VPC creation in specific domain", + "description": "list VPC offerings by display text", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains", + "name": "displaytext", "required": false, - "since": "4.18", - "type": "uuid" + "type": "string" }, { "description": "id of zone VPC offering is associated with", @@ -89768,18 +89992,18 @@ "type": "uuid" }, { - "description": "list VPC offerings by display text", + "description": "", "length": 255, - "name": "displaytext", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "true if need to list only default VPC offerings. Default value is false", + "description": "list VPC offerings by state", "length": 255, - "name": "isdefault", + "name": "state", "required": false, - "type": "boolean" + "type": "string" }, { "description": "", @@ -89789,11 +90013,12 @@ "type": "integer" }, { - "description": "list VPC offerings by state", + "description": "list VPC offerings by id", "length": 255, - "name": "state", + "name": "id", + "related": "updateVPCOffering,listVPCOfferings", "required": false, - "type": "string" + "type": "uuid" }, { "description": "list VPC offerings by name", @@ -89802,6 +90027,13 @@ "required": false, "type": "string" }, + { + "description": "true if need to list only default VPC offerings. Default value is false", + "length": 255, + "name": "isdefault", + "required": false, + "type": "boolean" + }, { "description": "list VPC offerings supporting certain services", "length": 255, @@ -89810,24 +90042,20 @@ "type": "list" }, { - "description": "list VPC offerings by id", + "description": "list VPC offerings available for VPC creation in specific domain", "length": 255, - "name": "id", - "related": "updateVPCOffering,listVPCOfferings", + "name": "domainid", + "related": "createDomain,listDomains,listDomains", "required": false, + "since": "4.18", "type": "uuid" } ], "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", + "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domainid", "type": "string" }, { @@ -89835,23 +90063,6 @@ "name": "created", "type": "date" }, - { - "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", - "type": "string" - }, - { - "description": "an alternate display text of the vpc offering.", - "name": "displaytext", - "type": "string" - }, - {}, { "description": "the list of supported services", "name": "service", @@ -89865,16 +90076,6 @@ "description": "the service provider name", "name": "provider", "response": [ - { - "description": "state of the network provider", - "name": "state", - "type": "string" - }, - { - "description": "uuid of the network provider", - "name": "id", - "type": "string" - }, { "description": "the destination physical network", "name": "destinationphysicalnetworkid", @@ -89885,20 +90086,30 @@ "name": "name", "type": "string" }, - { - "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" + }, { "description": "true if individual services can be enabled/disabled", "name": "canenableindividualservice", "type": "boolean" + }, + { + "description": "uuid of the network provider", + "name": "id", + "type": "string" + }, + { + "description": "services for this provider", + "name": "servicelist", + "type": "list" } ], "type": "list" @@ -89908,13 +90119,13 @@ "name": "capability", "response": [ { - "description": "the capability value", - "name": "value", + "description": "the capability name", + "name": "name", "type": "string" }, { - "description": "the capability name", - "name": "name", + "description": "the capability value", + "name": "value", "type": "string" }, { @@ -89928,24 +90139,19 @@ ], "type": "list" }, - { - "description": "the id of the vpc offering", - "name": "id", - "type": "string" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domain", + "description": "the routing mode for the network offering, supported types are Static or Dynamic.", + "name": "routingmode", "type": "string" }, { - "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zone", + "description": "the id of the vpc offering", + "name": "id", "type": "string" }, { @@ -89954,43 +90160,70 @@ "type": "boolean" }, { - "description": "the internet protocol of the vpc offering", - "name": "internetprotocol", + "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zone", "type": "string" }, { - "description": "true if network offering supports choosing AS numbers", - "name": "specifyasnumber", + "description": "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 vpc offering is default, false otherwise", + "name": "isdefault", "type": "boolean" }, { - "description": "the name of the vpc offering", - "name": "name", + "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", + "description": "an alternate display text of the vpc offering.", + "name": "displaytext", + "type": "string" + }, + { + "description": " indicates if the vpc offering supports distributed router for one-hop forwarding", + "name": "distributedvpcrouter", "type": "boolean" }, { - "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": "state of the vpc offering. Can be Disabled/Enabled", + "name": "state", + "type": "string" + }, + { + "description": "indicated if the offering can support region level vpc", + "name": "supportsregionLevelvpc", "type": "boolean" }, { - "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zoneid", + "description": "the internet protocol of the vpc 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": "true if network offering supports choosing AS numbers", + "name": "specifyasnumber", + "type": "boolean" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the routing mode for the network offering, supported types are Static or Dynamic.", - "name": "routingmode", + "description": "the name of the vpc offering", + "name": "name", "type": "string" } ] @@ -90015,18 +90248,18 @@ "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": "SolidFire Volume Size Including Hypervisor Snapshot Reserve", + "name": "solidFireVolumeSize", + "type": "long" + } ] }, { @@ -90035,10 +90268,10 @@ "name": "uploadVolume", "params": [ { - "description": "the format for the volume. Possible values include QCOW2, OVA, and VHD.", + "description": "Image store uuid", "length": 255, - "name": "format", - "required": true, + "name": "imagestoreuuid", + "required": false, "type": "string" }, { @@ -90049,33 +90282,39 @@ "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": "the ID of the disk offering. This must be a custom sized offering since during uploadVolume volume size is unknown.", "length": 255, - "name": "checksum", + "name": "diskofferingid", + "related": "", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "Upload volume for the project", + "description": "an optional accountName. Must be used with domainId.", "length": 255, - "name": "projectid", - "related": "createProject", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "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": "an optional accountName. Must be used with domainId.", + "description": "the name of the volume", "length": 255, - "name": "account", - "required": false, + "name": "name", + "required": true, + "type": "string" + }, + { + "description": "the format for the volume. Possible values include QCOW2, OVA, and VHD.", + "length": 255, + "name": "format", + "required": true, "type": "string" }, { @@ -90087,18 +90326,12 @@ "type": "uuid" }, { - "description": "Image store uuid", + "description": "Upload volume for the project", "length": 255, - "name": "imagestoreuuid", + "name": "projectid", + "related": "createProject", "required": false, - "type": "string" - }, - { - "description": "the name of the volume", - "length": 255, - "name": "name", - "required": true, - "type": "string" + "type": "uuid" }, { "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.", @@ -90109,12 +90342,12 @@ "type": "uuid" } ], - "related": "createVolume,updateVolume,listVolumes,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", + "related": "importVolume,createVolume,updateVolume,listVolumes,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", "response": [ { - "description": "the chain info of the volume", - "name": "chaininfo", - "type": "string" + "description": "min iops of the disk volume", + "name": "miniops", + "type": "long" }, { "description": "the display text of the disk offering", @@ -90122,114 +90355,91 @@ "type": "string" }, { - "description": "pod name of the volume", - "name": "podname", - "type": "string" - }, - { - "description": "ID of the disk volume", - "name": "id", - "type": "string" - }, - { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", - "type": "long" - }, - { - "description": "the path of the volume", - "name": "path", - "type": "string" - }, - { - "description": "the bytes actually consumed on disk", - "name": "physicalsize", - "type": "long" - }, - { - "description": "max iops of the disk volume", - "name": "maxiops", - "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": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" }, { - "description": "pod id of the volume", - "name": "podid", + "description": "cluster id of the volume", + "name": "clusterid", "type": "string" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "pod id of the volume", + "name": "podid", "type": "string" }, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", + "description": "the disk utilization", + "name": "utilization", "type": "string" }, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" + "description": "details for the volume check result, they may vary for different hypervisors", + "name": "volumecheckresult", + "type": "map" }, { - "description": "shared or local storage", - "name": "storagetype", + "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", + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", "type": "long" }, + {}, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", + "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", + "name": "deviceid", "type": "long" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", + "description": "true if volume has delete protection.", + "name": "deleteprotection", "type": "boolean" }, { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", "type": "boolean" }, + {}, { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", + "description": "size of the disk volume", + "name": "size", "type": "long" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", - "type": "string" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, { - "description": "IO requests write rate of the disk volume per 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": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "name of the disk volume", + "name": "name", + "type": "string" }, { "description": " an alternate display text of the template for the virtual machine", @@ -90237,39 +90447,54 @@ "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 account associated with the disk volume", - "name": "account", + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", "type": "string" }, + { + "description": "the bytes allocated", + "name": "virtualsize", + "type": "long" + }, { "description": "the project name of the vpn", "name": "project", "type": "string" }, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", - "type": "string" + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "type": "long" }, { - "description": "ID of the availability zone", - "name": "zoneid", + "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 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": "name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, { - "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 read (IO) of disk on the vm", @@ -90277,262 +90502,270 @@ "type": "long" }, { - "description": "state of the virtual machine", - "name": "vmstate", - "type": "string" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "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 domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + } + ], + "type": "set" }, { - "description": "min iops of the disk volume", - "name": "miniops", + "description": "the bytes actually consumed on disk", + "name": "physicalsize", "type": "long" }, { - "description": "true if volume has delete protection.", - "name": "deleteprotection", - "type": "boolean" + "description": "type of the virtual machine", + "name": "vmtype", + "type": "string" }, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", - "type": "string" + "description": "max iops of the disk volume", + "name": "maxiops", + "type": "long" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", + "description": "the date the disk volume was created", + "name": "created", "type": "date" }, - {}, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", + "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 status of the volume", - "name": "status", + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "name of the disk volume", - "name": "name", + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": "shared or local storage", + "name": "storagetype", "type": "string" }, { - "description": "type of the virtual machine", - "name": "vmtype", + "description": "the state of the disk volume", + "name": "state", "type": "string" }, { - "description": "name of the virtual machine", - "name": "vmname", + "description": "the format of the disk encryption if applicable", + "name": "encryptformat", "type": "string" }, { - "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": "provisioning type used to create volumes.", - "name": "provisioningtype", + "description": "cluster name where the volume is allocated", + "name": "clustername", "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": "details for the volume check result, they may vary for different hypervisors", - "name": "volumecheckresult", - "type": "map" + "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": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "path of the Domain the disk volume belongs to", - "name": "domainpath", + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, { - "description": "the disk utilization", - "name": "utilization", + "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", - "type": "string" + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "type": "long" }, - {}, { "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": "the write (IO) of disk on the vm", + "name": "diskiowrite", + "type": "long" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "size of the disk volume", - "name": "size", - "type": "long" + "description": "ID of the disk volume", + "name": "id", + "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "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": "display name of the virtual machine", + "name": "vmdisplayname", + "type": "string" }, { - "description": "the format of the disk encryption if applicable", - "name": "encryptformat", + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", "type": "string" }, { - "description": "the state of the disk volume", - "name": "state", + "description": "name of the virtual machine", + "name": "vmname", "type": "string" }, { - "description": "the domain associated with the disk volume", - "name": "domain", + "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", + "description": "the project id of the vpn", + "name": "projectid", + "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 virtual machine", - "name": "virtualmachineid", + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", + "type": "boolean" + }, + { + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "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": "name of the disk offering", + "name": "diskofferingname", + "type": "string" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "description": "the status of the volume", + "name": "status", "type": "string" }, { - "description": "the 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": "state of the virtual machine", + "name": "vmstate", + "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - } - ], - "type": "set" + "description": "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": "details for the volume repair result, they may vary for different hypervisors", + "name": "volumerepairresult", + "type": "map" + }, + { + "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" }, { - "description": "cluster id of the volume", - "name": "clusterid", + "description": "path of the Domain the disk volume belongs to", + "name": "domainpath", "type": "string" } ] @@ -90543,23 +90776,23 @@ "name": "configureOutOfBandManagement", "params": [ { - "description": "the host management interface driver, for example: ipmitool", + "description": "the host management interface user", "length": 255, - "name": "driver", + "name": "username", "required": true, "type": "string" }, { - "description": "the host management interface port", + "description": "the host management interface driver, for example: ipmitool", "length": 255, - "name": "port", + "name": "driver", "required": true, "type": "string" }, { - "description": "the host management interface user", + "description": "the host management interface password", "length": 255, - "name": "username", + "name": "password", "required": true, "type": "string" }, @@ -90571,28 +90804,23 @@ "type": "string" }, { - "description": "the ID of the host", + "description": "the host management interface port", "length": 255, - "name": "hostid", - "related": "declareHostAsDegraded,reconnectHost", + "name": "port", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "the host management interface password", + "description": "the ID of the host", "length": 255, - "name": "password", + "name": "hostid", + "related": "declareHostAsDegraded,reconnectHost", "required": true, - "type": "string" + "type": "uuid" } ], "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", @@ -90603,58 +90831,63 @@ "name": "hostid", "type": "string" }, - {}, { - "description": "the out-of-band management interface password", - "name": "password", - "type": "string" + "description": "true if out-of-band management is enabled for the host", + "name": "enabled", + "type": "boolean" }, { - "description": "the out-of-band management action (if issued)", - "name": "action", + "description": "the operation result description", + "name": "description", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the out-of-band management driver for the host", + "name": "driver", "type": "string" }, { - "description": "the operation result", - "name": "status", - "type": "boolean" + "description": "the out-of-band management interface port", + "name": "port", + "type": "string" }, { "description": "the out-of-band management interface address", "name": "address", "type": "string" }, + {}, + {}, { - "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 operation result", + "name": "status", + "type": "boolean" }, { - "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 interface password", + "name": "password", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {} + { + "description": "the out-of-band management interface powerState of the host", + "name": "powerstate", + "type": "powerstate" + }, + { + "description": "the out-of-band management action (if issued)", + "name": "action", + "type": "string" + } ], "since": "4.9.0" }, @@ -90687,26 +90920,26 @@ ], "related": "", "response": [ - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the storage tag", + "name": "name", "type": "string" }, {}, { - "description": "the name of the storage tag", - "name": "name", + "description": "the ID of the storage tag", + "name": "id", "type": "string" }, + {}, { "description": "the pool ID of the storage tag", "name": "poolid", "type": "long" }, { - "description": "the ID of the storage tag", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -90722,11 +90955,12 @@ "name": "createIpv4SubnetForGuestNetwork", "params": [ { - "description": "the CIDR size of IPv4 network. This is mutually exclusive with subnet.", + "description": "The zone Ipv4 subnet which the IPv4 subnet belongs to.", "length": 255, - "name": "cidrsize", - "required": false, - "type": "integer" + "name": "parentid", + "related": "listIpv4SubnetsForZone,dedicateIpv4SubnetForZone", + "required": true, + "type": "uuid" }, { "description": "The CIDR of this Ipv4 subnet.", @@ -90736,71 +90970,49 @@ "type": "string" }, { - "description": "The zone Ipv4 subnet which the IPv4 subnet belongs to.", + "description": "the CIDR size of IPv4 network. This is mutually exclusive with subnet.", "length": 255, - "name": "parentid", - "related": "listIpv4SubnetsForZone,dedicateIpv4SubnetForZone", - "required": true, - "type": "uuid" + "name": "cidrsize", + "required": false, + "type": "integer" } ], "related": "", "response": [ { - "description": "date when this IPv4 subnet was removed.", - "name": "removed", - "type": "date" - }, - { - "description": "name of network which the IPv4 subnet is associated with.", - "name": "networkname", + "description": "id of the IPv4 subnet for guest network", + "name": "id", "type": "string" }, - {}, { - "description": "date when this IPv4 subnet was allocated.", - "name": "allocated", + "description": "date when this IPv4 subnet was created.", + "name": "created", "type": "date" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "id of network which the IPv4 subnet is associated with.", - "name": "networkid", - "type": "string" - }, - { - "description": "subnet of the data center IPv4 subnet", - "name": "parentsubnet", - "type": "string" - }, - { - "description": "id of the data center IPv4 subnet", - "name": "parentid", + "description": "id of zone to which the IPv4 subnet belongs to.", + "name": "zoneid", "type": "string" }, - {}, { "description": "Id of the VPC which the IPv4 subnet is associated with.", "name": "vpcid", "type": "string" }, { - "description": "id of zone to which the IPv4 subnet belongs to.", - "name": "zoneid", - "type": "string" + "description": "date when this IPv4 subnet was removed.", + "name": "removed", + "type": "date" }, + {}, { "description": "Name of the VPC which the IPv4 subnet is associated with.", "name": "vpcname", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "id of the data center IPv4 subnet", + "name": "parentid", "type": "string" }, { @@ -90809,24 +91021,45 @@ "type": "string" }, { - "description": "subnet of the IPv4 network", - "name": "subnet", + "description": "subnet of the data center IPv4 subnet", + "name": "parentsubnet", "type": "string" }, { - "description": "date when this IPv4 subnet was created.", - "name": "created", + "description": "date when this IPv4 subnet was allocated.", + "name": "allocated", "type": "date" }, { - "description": "id of the IPv4 subnet for guest network", - "name": "id", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "subnet of the IPv4 network", + "name": "subnet", "type": "string" }, + {}, { "description": "id of zone to which the IPv4 subnet belongs to.", "name": "zonename", "type": "string" + }, + { + "description": "name of network which the IPv4 subnet is associated with.", + "name": "networkname", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "id of network which the IPv4 subnet is associated with.", + "name": "networkid", + "type": "string" } ], "since": "4.20.0" @@ -90837,11 +91070,11 @@ "name": "deleteVMSchedule", "params": [ { - "description": "ID of VM schedule", + "description": "ID of VM", "length": 255, - "name": "id", - "related": "", - "required": false, + "name": "virtualmachineid", + "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,createVMFromBackup,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "required": true, "type": "uuid" }, { @@ -90853,37 +91086,37 @@ "type": "list" }, { - "description": "ID of VM", + "description": "ID of VM schedule", "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, + "name": "id", + "related": "", + "required": false, "type": "uuid" } ], "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" - } + }, + {}, + {} ], "since": "4.19.0" }, @@ -90903,43 +91136,43 @@ ], "related": "listIsoPermissions,listTemplatePermissions,listIsoPermissions", "response": [ - {}, { "description": "the list of projects the template is available for", "name": "projectids", "type": "list" }, { - "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 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 ID of the domain to which the template belongs", - "name": "domainid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the 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 template ID", + "name": "id", "type": "string" }, - {}, { "description": "the list of accounts the template is available for", "name": "account", "type": "list" - } + }, + {} ] }, { @@ -90948,62 +91181,62 @@ "name": "listAnnotations", "params": [ { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "the id of the annotation", + "description": "optional: the id of the user of the annotation", "length": 255, - "name": "id", + "name": "userid", "required": false, + "since": "4.16.0", "type": "string" }, { - "description": "the id of the entity for which to show annotations", + "description": "", "length": 255, - "name": "entityid", + "name": "pagesize", "required": false, - "type": "string" + "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", + "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": "", "length": 255, - "name": "userid", + "name": "page", "required": false, - "since": "4.16.0", - "type": "string" + "type": "integer" }, { - "description": "List by keyword", + "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": "keyword", + "name": "annotationfilter", "required": false, + "since": "4.16.0", "type": "string" }, { - "description": "the entity type", + "description": "the id of the entity for which to show annotations", "length": 255, - "name": "entitytype", + "name": "entityid", "required": false, "type": "string" }, { - "description": "", + "description": "the id of the annotation", "length": 255, - "name": "pagesize", + "name": "id", "required": false, - "type": "integer" + "type": "string" } ], "related": "addAnnotation", @@ -91014,9 +91247,14 @@ "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 creation timestamp for this annotation", + "name": "created", + "type": "date" }, { "description": "the type of the annotated entity", @@ -91028,26 +91266,20 @@ "name": "jobid", "type": "string" }, - { - "description": "the (uu)id of the entity to which this annotation pertains", - "name": "entityid", - "type": "string" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, { - "description": "the removal timestamp for this annotation", - "name": "removed", - "type": "date" + "description": "the (uu)id of the annotation", + "name": "id", + "type": "string" }, - {}, - {}, { - "description": "the contents of the annotation", - "name": "annotation", + "description": "The (uu)id of the user that entered the annotation", + "name": "userid", "type": "string" }, { @@ -91056,18 +91288,19 @@ "type": "string" }, { - "description": "the creation timestamp for this annotation", - "name": "created", - "type": "date" + "description": "True if the annotation is available for admins only", + "name": "adminsonly", + "type": "boolean" }, + {}, { - "description": "the (uu)id of the annotation", - "name": "id", - "type": "string" + "description": "the removal timestamp for this annotation", + "name": "removed", + "type": "date" }, { - "description": "The (uu)id of the user that entered the annotation", - "name": "userid", + "description": "the contents of the annotation", + "name": "annotation", "type": "string" } ], @@ -91079,10 +91312,10 @@ "name": "addSwift", "params": [ { - "description": "the username for swift", + "description": "the URL for swift", "length": 255, - "name": "username", - "required": false, + "name": "url", + "required": true, "type": "string" }, { @@ -91093,71 +91326,71 @@ "type": "string" }, { - "description": "the URL for swift", + "description": " key for the user for swift", "length": 255, - "name": "url", - "required": true, + "name": "key", + "required": false, "type": "string" }, { - "description": " key for the user for swift", + "description": "the username for swift", "length": 255, - "name": "key", + "name": "username", "required": false, "type": "string" } ], "related": "addSecondaryStorage,listSwifts,addImageStore", "response": [ - { - "description": "the name of the image store", - "name": "name", - "type": "string" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the url of the image store", - "name": "url", + "description": "the name of the image store", + "name": "name", "type": "string" }, + { + "description": "defines if store is read-only", + "name": "readonly", + "type": "boolean" + }, {}, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, { "description": "the scope of the image store", "name": "scope", "type": "scopetype" }, { - "description": "the Zone name of the image store", - "name": "zonename", + "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 host's currently used disk size", "name": "disksizeused", "type": "long" }, { - "description": "defines if store is read-only", - "name": "readonly", - "type": "boolean" + "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", + "description": "the Zone name of the image store", + "name": "zonename", "type": "string" }, { - "description": "the provider name of the image store", - "name": "providername", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -91166,21 +91399,21 @@ "type": "string" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" + "description": "the protocol of the image store", + "name": "protocol", + "type": "string" }, - {}, { "description": "the ID of the image store", "name": "id", "type": "string" }, { - "description": "the protocol of the image store", - "name": "protocol", + "description": "the url of the image store", + "name": "url", "type": "string" - } + }, + {} ], "since": "3.0.0" }, @@ -91190,40 +91423,39 @@ "name": "updateVgpuProfile", "params": [ { - "description": "the maximum Y resolution", + "description": "the maximum number of vGPUs per physical GPU", "length": 255, - "name": "maxresolutiony", + "name": "maxvgpuperphysicalgpu", "required": false, "type": "long" }, { - "description": "the name of the vGPU profile", + "description": "the description of the vGPU profile", "length": 255, - "name": "name", + "name": "description", "required": false, "type": "string" }, { - "description": "the ID of the vGPU profile", + "description": "the video RAM size in MB", "length": 255, - "name": "id", - "related": "createVgpuProfile,updateVgpuProfile", - "required": true, - "type": "uuid" + "name": "videoram", + "required": false, + "type": "long" }, { - "description": "the maximum number of vGPUs per physical GPU", + "description": "the maximum Y resolution", "length": 255, - "name": "maxvgpuperphysicalgpu", + "name": "maxresolutiony", "required": false, "type": "long" }, { - "description": "the description of the vGPU profile", + "description": "the maximum X resolution", "length": 255, - "name": "description", + "name": "maxresolutionx", "required": false, - "type": "string" + "type": "long" }, { "description": "the maximum number of display heads", @@ -91233,45 +91465,52 @@ "type": "long" }, { - "description": "the video RAM size in MB", + "description": "the name of the vGPU profile", "length": 255, - "name": "videoram", + "name": "name", "required": false, - "type": "long" + "type": "string" }, { - "description": "the maximum X resolution", + "description": "the ID of the vGPU profile", "length": 255, - "name": "maxresolutionx", - "required": false, - "type": "long" + "name": "id", + "related": "createVgpuProfile,updateVgpuProfile", + "required": true, + "type": "uuid" } ], "related": "createVgpuProfile", "response": [ { - "description": "the maximum Y resolution", - "name": "maxresolutiony", + "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 maximum X resolution", + "name": "maxresolutionx", + "type": "long" }, { - "description": "the name of the vGPU profile", - "name": "gpucardname", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the vendor ID of the GPU card", - "name": "vendorid", + "description": "the description of the vGPU profile", + "name": "description", "type": "string" }, { - "description": "the description of the vGPU profile", - "name": "description", + "description": "the maximum number of display heads", + "name": "maxheads", + "type": "long" + }, + { + "description": "the display name of the GPU card", + "name": "name", "type": "string" }, { @@ -91280,9 +91519,14 @@ "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 vendor name of the GPU card", + "name": "vendorname", + "type": "string" }, { "description": "the maximum number of vGPUs per physical GPU", @@ -91290,17 +91534,15 @@ "type": "long" }, { - "description": "the ID of the GPU card", - "name": "id", + "description": "the name of the vGPU profile", + "name": "gpucardname", "type": "string" }, - {}, { - "description": "the vendor name of the GPU card", - "name": "vendorname", + "description": "the ID of the GPU card", + "name": "id", "type": "string" }, - {}, { "description": "the device ID of the GPU card", "name": "deviceid", @@ -91312,24 +91554,15 @@ "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", + "description": "the maximum Y resolution", + "name": "maxresolutiony", "type": "long" }, + {}, { - "description": "the maximum number of display heads", - "name": "maxheads", - "type": "long" + "description": "the vendor ID of the GPU card", + "name": "vendorid", + "type": "string" } ], "since": "4.21.0" @@ -91340,33 +91573,34 @@ "name": "listSnapshotPolicies", "params": [ { - "description": "the ID of the snapshot policy", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "id", - "related": "updateSnapshotPolicy,listSnapshotPolicies", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "", + "description": "the ID of the disk volume", "length": 255, - "name": "page", + "name": "volumeid", + "related": "importVolume,createVolume,updateVolume,listVolumes,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "List by keyword", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "keyword", + "name": "listall", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "", + "description": "the ID of the snapshot policy", "length": 255, - "name": "pagesize", + "name": "id", + "related": "updateSnapshotPolicy,listSnapshotPolicies", "required": false, - "type": "integer" + "type": "uuid" }, { "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", @@ -91377,75 +91611,69 @@ "type": "boolean" }, { - "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" - } - ], - "related": "updateSnapshotPolicy", - "response": [ - { - "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" + "type": "integer" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "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 snapshot policy", - "name": "id", - "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 list of zones in which snapshot backup is scheduled", - "name": "zone", - "type": "set" + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" }, - {}, { - "description": "time the snapshot is scheduled to be taken.", - "name": "schedule", - "type": "string" + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "createProject", + "required": false, + "type": "uuid" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "", + "length": 255, + "name": "page", + "required": false, "type": "integer" + } + ], + "related": "updateSnapshotPolicy", + "response": [ + { + "description": "the name of the disk volume", + "name": "volumename", + "type": "string" }, { "description": "the list of resource tags associated", "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": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { @@ -91454,18 +91682,18 @@ "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": "customer associated with the tag", - "name": "customer", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -91474,18 +91702,18 @@ "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 project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -91496,6 +91724,53 @@ ], "type": "set" }, + { + "description": "the ID of the snapshot policy", + "name": "id", + "type": "string" + }, + { + "description": "The list of zones in which snapshot backup is scheduled", + "name": "zone", + "type": "set" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the time zone of the snapshot policy", + "name": "timezone", + "type": "string" + }, + { + "description": "time the snapshot is scheduled to be taken.", + "name": "schedule", + "type": "string" + }, + {}, + { + "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 ID of the disk volume", + "name": "volumeid", + "type": "string" + }, { "description": "is this policy for display to the regular user", "name": "fordisplay", @@ -91507,9 +91782,9 @@ "type": "short" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "maximum number of snapshots retained", + "name": "maxsnaps", + "type": "int" } ] }, @@ -91534,6 +91809,13 @@ "since": "4.15.1", "type": "string" }, + { + "description": "Lifetime of phase 2 VPN connection to the customer gateway, in seconds", + "length": 255, + "name": "esplifetime", + "required": false, + "type": "long" + }, { "description": "public ip address id of the customer gateway", "length": 255, @@ -91548,13 +91830,6 @@ "required": true, "type": "string" }, - { - "description": "If DPD is enabled for VPN connection", - "length": 255, - "name": "dpd", - "required": false, - "type": "boolean" - }, { "description": "Lifetime of phase 1 VPN connection to the customer gateway, in seconds", "length": 255, @@ -91563,16 +91838,16 @@ "type": "long" }, { - "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": "Force encapsulation for Nat Traversal", + "description": "If DPD is enabled for VPN connection", "length": 255, - "name": "forceencap", + "name": "dpd", "required": false, "type": "boolean" }, @@ -91583,6 +91858,13 @@ "required": false, "type": "string" }, + { + "description": "ESP policy of the customer gateway", + "length": 255, + "name": "esppolicy", + "required": true, + "type": "string" + }, { "description": "IPsec Preshared-Key of the customer gateway. Cannot contain newline or double quotes.", "length": 255, @@ -91598,20 +91880,6 @@ "required": false, "type": "uuid" }, - { - "description": "the account associated with the gateway. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, - { - "description": "ESP policy of the customer gateway", - "length": 255, - "name": "esppolicy", - "required": true, - "type": "string" - }, { "description": "id of customer gateway", "length": 255, @@ -91626,111 +91894,113 @@ "name": "cidrlist", "required": true, "type": "string" + }, + { + "description": "Force encapsulation for Nat Traversal", + "length": 255, + "name": "forceencap", + "required": false, + "type": "boolean" } ], "related": "", "response": [ { - "description": "IKE policy of customer gateway", - "name": "ikepolicy", + "description": "the project name", + "name": "project", "type": "string" }, - { - "description": "Lifetime of ESP SA of customer gateway", - "name": "esplifetime", - "type": "long" - }, { "description": "the domain path of the owner", "name": "domainpath", "type": "string" }, { - "description": "the project id", - "name": "projectid", + "description": "name of the customer gateway", + "name": "name", "type": "string" }, { - "description": "if Force NAT Encapsulation is enabled for customer gateway", - "name": "forceencap", + "description": "Lifetime of IKE SA of customer gateway", + "name": "ikelifetime", + "type": "long" + }, + { + "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": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", + "name": "ikeversion", "type": "string" }, { - "description": "the domain id of the owner", - "name": "domainid", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "IPsec preshared-key of customer gateway", - "name": "ipsecpsk", - "type": "string" + "description": "Lifetime of ESP SA of customer gateway", + "name": "esplifetime", + "type": "long" }, { - "description": "name of the customer gateway", - "name": "name", + "description": "the domain name of the owner", + "name": "domain", "type": "string" }, { - "description": "public ip address id of the customer gateway", - "name": "gateway", + "description": "the project id", + "name": "projectid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the owner", + "name": "account", "type": "string" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "if Force NAT Encapsulation is enabled for customer gateway", + "name": "forceencap", + "type": "boolean" }, {}, { - "description": "the vpn gateway ID", - "name": "id", + "description": "guest ip of the customer gateway", + "name": "ipaddress", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "IPsec policy of customer gateway", - "name": "esppolicy", + "description": "IKE policy of customer gateway", + "name": "ikepolicy", "type": "string" }, { - "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", + "type": "string" }, { - "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", - "name": "ikeversion", + "description": "the vpn gateway ID", + "name": "id", "type": "string" }, + {}, { - "description": "the owner", - "name": "account", + "description": "IPsec preshared-key of customer gateway", + "name": "ipsecpsk", "type": "string" }, { - "description": "the project name", - "name": "project", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "guest ip of the customer gateway", - "name": "ipaddress", - "type": "string" + "description": "For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.", + "name": "splitconnections", + "type": "boolean" }, { "description": "the current status of the latest async job acting on this object", @@ -91738,18 +92008,23 @@ "type": "integer" }, { - "description": "Lifetime of IKE SA of customer gateway", - "name": "ikelifetime", - "type": "long" + "description": "IPsec policy of customer gateway", + "name": "esppolicy", + "type": "string" }, { - "description": "For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.", - "name": "splitconnections", - "type": "boolean" + "description": "public ip address id of the customer gateway", + "name": "gateway", + "type": "string" }, { - "description": "the domain name of the owner", - "name": "domain", + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" + }, + { + "description": "the domain id of the owner", + "name": "domainid", "type": "string" } ] @@ -91759,6 +92034,21 @@ "isasync": true, "name": "applyTungstenFabricTag", "params": [ + { + "description": "the uuid of Tungsten-Fabric application policy set", + "length": 255, + "name": "applicationpolicysetuuid", + "required": false, + "type": "string" + }, + { + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" + }, { "description": "the uuid of networks", "length": 255, @@ -91781,11 +92071,11 @@ "type": "list" }, { - "description": "the uuid of Tungsten-Fabric application policy set", + "description": "the uuid of nics", "length": 255, - "name": "applicationpolicysetuuid", + "name": "nicuuid", "required": false, - "type": "string" + "type": "list" }, { "description": "the uuid of Tungsten-Fabric tag", @@ -91793,62 +92083,52 @@ "name": "taguuid", "required": true, "type": "string" - }, - { - "description": "the ID of zone", - "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, - "type": "uuid" - }, - { - "description": "the uuid of nics", - "length": 255, - "name": "nicuuid", - "required": false, - "type": "list" } ], "related": "", "response": [ - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Tungsten-Fabric tag type uuid", + "name": "uuid", "type": "string" }, + {}, { - "description": "list Tungsten-Fabric policy", - "name": "policy", + "description": "list Tungsten-Fabric vm", + "name": "vm", "type": "list" }, { - "description": "Tungsten-Fabric tag type uuid", - "name": "uuid", + "description": "the current status of the latest 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 tag name", - "name": "name", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, - {}, { "description": "list Tungsten-Fabric network", "name": "network", "type": "list" }, { - "description": "list Tungsten-Fabric vm", - "name": "vm", + "description": "list Tungsten-Fabric policy", + "name": "policy", "type": "list" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Tungsten-Fabric tag name", + "name": "name", + "type": "string" }, + {}, { "description": "list Tungsten-Fabric nic", "name": "nic", @@ -91858,11 +92138,6 @@ "description": "Tungsten-Fabric provider zone id", "name": "zoneid", "type": "long" - }, - { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", - "type": "string" } ] }, @@ -91872,12 +92147,12 @@ "name": "updateObjectStoragePool", "params": [ { - "description": "Object Store ID", + "description": "the total size of the object store in GiB. Used for tracking capacity and sending alerts. Set to 0 to stop tracking.", "length": 255, - "name": "id", - "related": "addObjectStoragePool,updateObjectStoragePool", - "required": true, - "type": "uuid" + "name": "size", + "required": false, + "since": "4.21", + "type": "long" }, { "description": "the url for the object store", @@ -91887,12 +92162,12 @@ "type": "string" }, { - "description": "the total size of the object store in GiB. Used for tracking capacity and sending alerts. Set to 0 to stop tracking.", + "description": "Object Store ID", "length": 255, - "name": "size", - "required": false, - "since": "4.21", - "type": "long" + "name": "id", + "related": "addObjectStoragePool,updateObjectStoragePool", + "required": true, + "type": "uuid" }, { "description": "the name for the object store", @@ -91904,9 +92179,15 @@ ], "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 url of the object store", + "name": "url", "type": "string" }, { @@ -91915,9 +92196,14 @@ "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the ID of the object store", + "name": "id", + "type": "string" }, { "description": "the name of the object store", @@ -91925,16 +92211,15 @@ "type": "string" }, { - "description": "the object store currently used size", - "name": "storageused", + "description": "the allocated size of the object store", + "name": "storageallocated", "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, - {}, { "description": "the total size of the object store", "name": "storagetotal", @@ -91942,19 +92227,9 @@ }, {}, { - "description": "the allocated size of the object store", - "name": "storageallocated", + "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": "the url of the object store", - "name": "url", - "type": "string" } ], "since": "4.19.0" @@ -91964,6 +92239,13 @@ "isasync": false, "name": "registerExtension", "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": "ID of the extension", "length": 255, @@ -91973,73 +92255,52 @@ "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" }, { - "description": "Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].endpoint.url=urlvalue", - "length": 255, - "name": "details", - "required": false, - "type": "map" - }, - { - "description": "Type of the resource", + "description": "ID of the resource to register the extension with", "length": 255, - "name": "resourcetype", + "name": "resourceid", "required": true, "type": "string" } ], "related": "listExtensions,deleteExtension,updateExtension,unregisterExtension", "response": [ - { - "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": "Creation timestamp of the extension", + "name": "created", + "type": "date" }, + {}, { - "description": "Type of the extension", - "name": "type", + "description": "Description of the extension", + "name": "description", "type": "string" }, + {}, { "description": "ID of the extension", "name": "id", "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", - "type": "string" - }, - { - "description": "Description of the extension", - "name": "description", - "type": "string" - }, { "description": "List of resources to which extension is registered to", "name": "resources", "response": [ { - "description": "Name of the resource associated with this mapping", - "name": "name", + "description": "Creation timestamp of the mapping", + "name": "created", + "type": "date" + }, + { + "description": "ID of the resource associated with the extension", + "name": "id", "type": "string" }, { @@ -92053,48 +92314,62 @@ "type": "map" }, { - "description": "ID of the resource associated with the extension", - "name": "id", + "description": "Name of the resource associated with this mapping", + "name": "name", "type": "string" - }, - { - "description": "Creation timestamp of the mapping", - "name": "created", - "type": "date" } ], "type": "list" }, { - "description": "Name of the extension", - "name": "name", + "description": "Removal timestamp of the extension, if applicable", + "name": "removed", + "type": "date" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "The state of the extension", + "name": "state", "type": "string" }, { - "description": "The path of the entry point fo the extension", - "name": "path", + "description": "Name of the extension", + "name": "name", "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", "type": "boolean" }, { - "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": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { "description": "True if the extension is added by admin", "name": "isuserdefined", "type": "boolean" + }, + { + "description": "The details of the extension", + "name": "details", + "type": "map" } ], "since": "4.21.0" @@ -92104,13 +92379,6 @@ "isasync": false, "name": "lockAccount", "params": [ - { - "description": "Locks the specified account.", - "length": 255, - "name": "account", - "required": true, - "type": "string" - }, { "description": "Locks the specified account on this domain.", "length": 255, @@ -92118,163 +92386,109 @@ "related": "createDomain,listDomains,listDomains", "required": true, "type": "uuid" + }, + { + "description": "Locks the specified account.", + "length": 255, + "name": "account", + "required": true, + "type": "string" } ], "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": "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 tagged resource limit and count for the account", + "name": "taggedresources", + "type": "list" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", + "description": "the total number of templates which have been created by this account", + "name": "templatetotal", "type": "long" }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the name of the account", - "name": "name", - "type": "string" - }, - { - "description": "the total number of backups available to this account", - "name": "backupavailable", - "type": "string" - }, - { - "description": "the total object storage space (in GiB) the account can own", - "name": "objectstoragelimit", - "type": "string" - }, - { - "description": "the total number of public ip addresses this account can acquire", - "name": "iplimit", - "type": "string" - }, - { - "description": "the total number of backups which can be stored by this account", - "name": "backuplimit", - "type": "string" - }, { "description": "the total number of network traffic bytes received", "name": "receivedbytes", "type": "long" }, { - "description": "the total number of templates which have been created by this account", - "name": "templatetotal", + "description": "the total number of backups stored by this account", + "name": "backuptotal", "type": "long" }, { - "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", + "type": "long" }, { - "description": "the total number of gpus the account can own", - "name": "gpulimit", + "description": "the name of the account", + "name": "name", "type": "string" }, { - "description": "the total backup storage space (in GiB) available to the account", - "name": "backupstorageavailable", + "description": "the total secondary storage space (in GiB) available to be used for this account", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "the total number of vpcs the account can own", - "name": "vpclimit", + "description": "the total number of buckets available to this account", + "name": "bucketavailable", "type": "string" }, { - "description": "the total number of public ip addresses allocated for this account", - "name": "iptotal", - "type": "long" - }, - { - "description": "the total number of vpcs owned by account", - "name": "vpctotal", - "type": "long" + "description": "the total object storage space (in GiB) the account can own", + "name": "objectstoragelimit", + "type": "string" }, { "description": "the list of users associated with account", "name": "user", "response": [ { - "description": "the user lastname", - "name": "lastname", + "description": "the user ID", + "name": "id", "type": "string" }, { - "description": "the account ID of the user", - "name": "accountid", + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", "type": "string" }, { - "description": "the domain name of the user", - "name": "domain", + "description": "the timezone user was created in", + "name": "timezone", "type": "string" }, { - "description": "the user ID", - "name": "id", + "description": "the secret key of the user", + "name": "secretkey", "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", - "type": "string" + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", + "type": "boolean" }, { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" + "description": "true if user has two factor authentication is mandated", + "name": "is2famandated", + "type": "boolean" }, { - "description": "the user state", - "name": "state", + "description": "the name of the role", + "name": "rolename", "type": "string" }, { - "description": "true if user has two factor authentication enabled", - "name": "is2faenabled", + "description": "true if user is default, false otherwise", + "name": "isdefault", "type": "boolean" }, { @@ -92283,132 +92497,156 @@ "type": "string" }, { - "description": "the user email address", - "name": "email", - "type": "string" + "description": "the date and time the user account was created", + "name": "created", + "type": "date" }, { - "description": "the name of the role", - "name": "rolename", + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", - "type": "boolean" - }, - { - "description": "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", - "name": "created", - "type": "date" + "description": "the api key of the user", + "name": "apikey", + "type": "string" }, { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", + "description": "the user lastname", + "name": "lastname", "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": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the account name of the user", + "name": "account", + "type": "string" }, { "description": "the domain ID of the user", "name": "domainid", "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 account name of the user", - "name": "account", + "description": "the user state", + "name": "state", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "true if user has two factor authentication enabled", + "name": "is2faenabled", + "type": "boolean" }, { - "description": "the api key of the user", - "name": "apikey", + "description": "the account ID of the user", + "name": "accountid", "type": "string" }, { - "description": "the secret key of the user", - "name": "secretkey", + "description": "the user firstname", + "name": "firstname", "type": "string" }, { - "description": "the user firstname", - "name": "firstname", + "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 email address", + "name": "email", "type": "string" } ], "type": "list" }, { - "description": "the date when this account was created", - "name": "created", - "type": "date" + "description": "the total number of networks the account can own", + "name": "networklimit", + "type": "string" }, { - "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", + "type": "string" }, { - "description": "id of the Domain the account belongs to", - "name": "domainid", + "description": "path of the Domain the account belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the total number of projects the account can own", - "name": "projectlimit", - "type": "string" + "description": "the total number of snapshots stored by this account", + "name": "snapshottotal", + "type": "long" }, - {}, { - "description": "the total object storage space (in GiB) available to the account", - "name": "objectstorageavailable", + "description": "the total secondary storage space (in GiB) owned by account", + "name": "secondarystoragetotal", + "type": "float" + }, + { + "description": "the total number of cpu cores available to be created for this account", + "name": "cpuavailable", "type": "string" }, { - "description": "the total number of public ip addresses available for this account to acquire", - "name": "ipavailable", + "description": "the total number of gpus the account can own", + "name": "gpulimit", "type": "string" }, { - "description": "the total number of networks owned by account", - "name": "networktotal", + "description": "the total 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 backup storage space (in GiB) owned by the account", + "name": "backupstoragetotal", + "type": "long" + }, + { + "description": "true if the account requires cleanup", + "name": "iscleanuprequired", + "type": "boolean" + }, + { + "description": "name of the Domain the account belongs to", + "name": "domain", "type": "string" }, { - "description": "the total primary storage space (in GiB) available to be used for this account", - "name": "primarystorageavailable", + "description": "details for the account", + "name": "accountdetails", + "type": "map" + }, + { + "description": "the total number of public ip addresses available for this account to acquire", + "name": "ipavailable", + "type": "string" + }, + { + "description": "the total secondary storage space (in GiB) the account can own", + "name": "secondarystoragelimit", "type": "string" }, { @@ -92417,19 +92655,115 @@ "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 number of public ip addresses this account can acquire", + "name": "iplimit", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "account type (admin, domain-admin, user)", + "name": "accounttype", + "type": "integer" + }, + { + "description": "the 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 account", + "name": "iptotal", "type": "long" }, + { + "description": "the total number of snapshots which can be stored by this account", + "name": "snapshotlimit", + "type": "string" + }, { "description": "the total object storage space (in GiB) owned by the account", "name": "objectstoragetotal", "type": "long" }, { - "description": "true if account is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the total number of templates available to be created by this account", + "name": "templateavailable", + "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 backup storage space (in GiB) the account can own", + "name": "backupstoragelimit", + "type": "string" + }, + { + "description": "the total number of vpcs owned by account", + "name": "vpctotal", + "type": "long" + }, + { + "description": "the total number of virtual machines available for this account to acquire", + "name": "vmavailable", + "type": "string" + }, + { + "description": "the total number of virtual machines that can be deployed by this account", + "name": "vmlimit", + "type": "string" + }, + { + "description": "the state of the account", + "name": "state", + "type": "string" + }, + { + "description": "the total number of networks available to be created for this account", + "name": "networkavailable", + "type": "string" + }, + { + "description": "the total backup storage space (in GiB) available to the account", + "name": "backupstorageavailable", + "type": "string" + }, + { + "description": "the default zone of the account", + "name": "defaultzoneid", + "type": "string" + }, + { + "description": "the total number of templates which can be created by this account", + "name": "templatelimit", + "type": "string" + }, + { + "description": "the name of the role", + "name": "rolename", + "type": "string" + }, + { + "description": "the total primary storage space (in GiB) the account can own", + "name": "primarystoragelimit", + "type": "string" }, { "description": "the total volume available for this account", @@ -92437,19 +92771,39 @@ "type": "string" }, { - "description": "the total number of projects being administrated by this account", - "name": "projecttotal", + "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 account", + "name": "networktotal", "type": "long" }, { - "description": "the total number of buckets available to this account", - "name": "bucketavailable", + "description": "the list of acl groups that account belongs to", + "name": "groups", + "type": "list" + }, + { + "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 number of projects available for administration by this account", + "name": "projectavailable", + "type": "string" + }, + { + "description": "the total number of gpus available to be created for this account", + "name": "gpuavailable", + "type": "string" + }, + { + "description": "the id of the account", + "name": "id", + "type": "string" }, { "description": "the total number of buckets which can be stored by this account", @@ -92457,273 +92811,325 @@ "type": "string" }, { - "description": "the total memory (in MB) the account can own", - "name": "memorylimit", + "description": "the total number of buckets stored by this account", + "name": "buckettotal", + "type": "long" + }, + { + "description": "the total number of projects being administrated by this account", + "name": "projecttotal", + "type": "long" + }, + { + "description": "the total number of gpus owned by account", + "name": "gputotal", + "type": "long" + }, + { + "description": "the total number of backups which can be stored by this account", + "name": "backuplimit", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "id of the Domain the account belongs to", + "name": "domainid", + "type": "string" }, { - "description": "the total number of snapshots stored by this account", - "name": "snapshottotal", + "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", + "name": "roletype", + "type": "string" + }, + { + "description": "the total memory (in MB) owned by account", + "name": "memorytotal", "type": "long" }, { - "description": "the ID of the role", - "name": "roleid", - "type": "string" + "description": "the date when this account was created", + "name": "created", + "type": "date" }, { - "description": "the total number of templates which can be created by this account", - "name": "templatelimit", + "description": "the total number of snapshots available for this account", + "name": "snapshotavailable", "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 volume being used by this account", - "name": "volumetotal", - "type": "long" - }, - { - "description": "the total number of backups stored by this account", - "name": "backuptotal", - "type": "long" + "description": "true if account is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "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 backup storage space (in GiB) owned by the account", - "name": "backupstoragetotal", - "type": "long" + "description": "the total primary storage space (in GiB) available to be used for this account", + "name": "primarystorageavailable", + "type": "string" }, { - "description": "details for the account", - "name": "accountdetails", - "type": "map" + "description": "the total number of cpu cores the account can own", + "name": "cpulimit", + "type": "string" }, { - "description": "the id of the account", - "name": "id", + "description": "the total volume which can be used by this account", + "name": "volumelimit", "type": "string" }, { - "description": "the total number of virtual machines that can be deployed by this account", - "name": "vmlimit", + "description": "the total number of vpcs available to be created for this account", + "name": "vpcavailable", "type": "string" }, { - "description": "the total number of gpus owned by account", - "name": "gputotal", - "type": "long" + "description": "the total number of virtual machines stopped for this account", + "name": "vmstopped", + "type": "integer" }, + {}, { - "description": "the total number of cpu cores owned by account", - "name": "cputotal", + "description": "the total number of virtual machines deployed by this account", + "name": "vmtotal", "type": "long" }, { - "description": "the total number of cpu cores available to be created for this account", - "name": "cpuavailable", + "description": "the total object storage space (in GiB) available to the account", + "name": "objectstorageavailable", "type": "string" }, { - "description": "the total secondary storage space (in GiB) the account can own", - "name": "secondarystoragelimit", + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { "description": "the total number of virtual machines running for this account", "name": "vmrunning", "type": "integer" + } + ] + }, + { + "description": "Stops a router.", + "isasync": true, + "name": "stopRouter", + "params": [ + { + "description": "the ID of the router", + "length": 255, + "name": "id", + "related": "listRouters,rebootRouter,stopRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", + "required": true, + "type": "uuid" }, { - "description": "the total number of snapshots available for this account", - "name": "snapshotavailable", + "description": "Force stop the VM (vm is marked as Stopped even when command fails to be send to the backend, otherwise a force poweroff is attempted). To be used if the caller knows the VM is stopped and should be marked as such.", + "length": 255, + "name": "forced", + "required": false, + "type": "boolean" + } + ], + "related": "listRouters,rebootRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", + "response": [ + { + "description": "the host ID for the router", + "name": "hostid", "type": "string" }, { - "description": "the total primary storage space (in GiB) the account can own", - "name": "primarystoragelimit", - "type": "string" + "description": "Last executed health check result for the router", + "name": "healthcheckresults", + "response": [ + { + "description": "the type of the health check - basic or advanced", + "name": "checktype", + "type": "string" + }, + { + "description": "the date this VPC was created", + "name": "lastupdated", + "type": "date" + }, + { + "description": "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" + }, + { + "description": "result of the health check if available", + "name": "success", + "type": "boolean" + } + ], + "type": "list" }, { - "description": "the state of the account", - "name": "state", + "description": "the control state of the host for the router", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the total number of virtual machines deployed by this account", - "name": "vmtotal", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the total number of virtual machines stopped for this account", - "name": "vmstopped", - "type": "integer" + "description": "the template name for the router", + "name": "templatename", + "type": "string" }, { - "description": "the total number of cpu cores the account can own", - "name": "cpulimit", + "description": "the id of the router", + "name": "id", "type": "string" }, { - "description": "true if the account requires cleanup", - "name": "iscleanuprequired", - "type": "boolean" + "description": "the date and time the router was created", + "name": "created", + "type": "date" }, { - "description": "the total number of snapshots which can be stored by this account", - "name": "snapshotlimit", + "description": "role of the domain router", + "name": "role", "type": "string" }, { - "description": "the total backup storage space (in GiB) the account can own", - "name": "backupstoragelimit", + "description": "the second DNS for the router", + "name": "dns2", "type": "string" }, { - "description": "the total number of buckets stored by this account", - "name": "buckettotal", - "type": "long" + "description": "true if the router template requires upgrader", + "name": "requiresupgrade", + "type": "boolean" }, { - "description": "the list of acl groups that account belongs to", - "name": "groups", - "type": "list" + "description": "the name of the corresponding guest network", + "name": "guestnetworkname", + "type": "string" }, { - "description": "The tagged resource limit and count for the account", - "name": "taggedresources", - "type": "list" + "description": "the state of redundant virtual router", + "name": "redundantstate", + "type": "string" }, { - "description": "the total number of gpus available to be created for this account", - "name": "gpuavailable", + "description": "the public MAC address for the router", + "name": "publicmacaddress", "type": "string" }, { - "description": "the name of the role", - "name": "rolename", + "description": "the link local IP address for the router", + "name": "linklocalip", "type": "string" }, { - "description": "the total number of templates available to be created by this account", - "name": "templateavailable", + "description": "the public netmask for the router", + "name": "publicnetmask", "type": "string" }, { - "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", - "name": "roletype", + "description": "CPU arch of the router", + "name": "arch", "type": "string" }, { - "description": "the total memory (in MB) owned by account", - "name": "memorytotal", - "type": "long" + "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", - "type": "string" + "description": "if this router is an redundant virtual router", + "name": "isredundantrouter", + "type": "boolean" }, { - "description": "the total number of networks available to be created for this account", - "name": "networkavailable", + "description": "the name of VPC the router belongs to", + "name": "vpcname", "type": "string" - } - ] - }, - { - "description": "Stops a router.", - "isasync": true, - "name": "stopRouter", - "params": [ + }, { - "description": "the ID of the router", - "length": 255, - "name": "id", - "related": "listRouters,rebootRouter,stopRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", - "required": true, - "type": "uuid" + "description": "the version of the code / software in the router", + "name": "softwareversion", + "type": "string" }, { - "description": "Force stop the VM (vm is marked as Stopped even when command fails to be send to the backend, otherwise a force poweroff is attempted). To be used if the caller knows the VM is stopped and should be marked as such.", - "length": 255, - "name": "forced", - "required": false, + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" - } - ], - "related": "listRouters,rebootRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", - "response": [ + }, { - "description": "the domain associated with the router", - "name": "domain", + "description": "the gateway for the router", + "name": "gateway", "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "the ID of the corresponding guest network", + "name": "guestnetworkid", "type": "string" }, { - "description": "the Zone name for the router", - "name": "zonename", + "description": "the account associated with the router", + "name": "account", "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 list of nics associated with the router", "name": "nic", "response": [ { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" + "description": "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": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the isolation uri of the nic", + "name": "isolationuri", "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" }, { @@ -92732,53 +93138,58 @@ "type": "integer" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "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 Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "Type of adapter if available", + "name": "adaptertype", "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": "the type of the nic", - "name": "type", + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" }, { @@ -92787,9 +93198,9 @@ "type": "integer" }, { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { "description": "the isolated private VLAN type if available", @@ -92797,96 +93208,72 @@ "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "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": "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": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "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": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the netmask of the nic", + "name": "netmask", "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": "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": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" } ], "type": "set" }, - { - "description": "the template ID for the router", - "name": "templateid", - "type": "string" - }, - { - "description": "the gateway for the router", - "name": "gateway", - "type": "string" - }, + {}, { "description": "the Pod name for the router", "name": "podname", "type": "string" }, { - "description": "path of the Domain the router belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the guest netmask for the router", - "name": "guestnetmask", - "type": "string" - }, - { - "description": "true if any health checks had failed", - "name": "healthchecksfailed", - "type": "boolean" - }, - { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", + "description": "the template ID for the router", + "name": "templateid", "type": "string" }, { - "description": "the ID of the corresponding guest network", - "name": "guestnetworkid", + "description": "the second IPv6 DNS for the router", + "name": "ip6dns2", "type": "string" }, { @@ -92895,141 +93282,33 @@ "type": "string" }, { - "description": "the public IP address for the router", - "name": "publicip", + "description": "the first IPv6 DNS for the router", + "name": "ip6dns1", "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 domain ID associated with the router", "name": "domainid", "type": "string" }, - { - "description": "the state of redundant virtual router", - "name": "redundantstate", - "type": "string" - }, - { - "description": "VPC the router belongs to", - "name": "vpcid", - "type": "string" - }, { "description": "the ID of the service offering of the virtual machine", "name": "serviceofferingid", "type": "string" }, - { - "description": "if this router is an redundant virtual router", - "name": "isredundantrouter", - "type": "boolean" - }, - { - "description": "true if the router template requires upgrader", - "name": "requiresupgrade", - "type": "boolean" - }, - { - "description": "the link local IP address for the router", - "name": "linklocalip", - "type": "string" - }, - { - "description": "the hostname for the router", - "name": "hostname", - "type": "string" - }, - { - "description": "the project id of the ipaddress", - "name": "projectid", - "type": "string" - }, - { - "description": "the public netmask for the router", - "name": "publicnetmask", - "type": "string" - }, - { - "description": "CPU arch of the router", - "name": "arch", - "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", "type": "string" }, { - "description": "the ID of the corresponding public network", - "name": "publicnetworkid", - "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", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the first DNS for the router", + "name": "dns1", "type": "string" }, { @@ -93038,43 +93317,38 @@ "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, - { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", + "description": "the link local netmask for the router", + "name": "linklocalnetmask", "type": "string" }, { - "description": "the guest MAC address for the router", - "name": "guestmacaddress", + "description": "the Zone name for the router", + "name": "zonename", "type": "string" }, { - "description": "the name of the corresponding guest network", - "name": "guestnetworkname", + "description": "the domain associated with the router", + "name": "domain", "type": "string" }, { - "description": "the account associated with the router", - "name": "account", + "description": "the version of template", + "name": "version", "type": "string" }, { - "description": "the version of template", - "name": "version", + "description": "the guest netmask for the router", + "name": "guestnetmask", "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": "the public MAC address for the router", - "name": "publicmacaddress", + "description": "the ID of the corresponding link local network", + "name": "linklocalnetworkid", "type": "string" }, { @@ -93083,13 +93357,18 @@ "type": "state" }, { - "description": "role of the domain router", - "name": "role", + "description": "the Pod ID for the router", + "name": "podid", "type": "string" }, { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", + "description": "the hostname for the router", + "name": "hostname", + "type": "string" + }, + { + "description": "the network domain for the router", + "name": "networkdomain", "type": "string" }, { @@ -93098,44 +93377,45 @@ "type": "string" }, { - "description": "the network domain for the router", - "name": "networkdomain", + "description": "path of the Domain the router belongs to", + "name": "domainpath", "type": "string" }, + {}, { - "description": "the version of the code / software in the router", - "name": "softwareversion", + "description": "the guest MAC address for the router", + "name": "guestmacaddress", "type": "string" }, { - "description": "the Pod ID for the router", - "name": "podid", + "description": "the Zone ID for the router", + "name": "zoneid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the name of the router", + "name": "name", + "type": "string" }, { - "description": "the template name for the router", - "name": "templatename", + "description": "the public IP address for the router", + "name": "publicip", "type": "string" }, { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", + "description": "the ID of the corresponding public network", + "name": "publicnetworkid", "type": "string" }, { - "description": "the host ID for the router", - "name": "hostid", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "VPC the router belongs to", + "name": "vpcid", + "type": "string" } ] }, @@ -93154,27 +93434,27 @@ } ], "response": [ - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async 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": "3.0.0" @@ -93185,11 +93465,12 @@ "name": "createTungstenFabricFirewallPolicy", "params": [ { - "description": "Tungsten-Fabric firewall policy name", + "description": "the ID of zone", "length": 255, - "name": "name", + "name": "zoneid", + "related": "listZones", "required": true, - "type": "string" + "type": "uuid" }, { "description": "the sequence of Tungsten-Fabric firewall policy", @@ -93199,60 +93480,59 @@ "type": "integer" }, { - "description": "the uuid of Tungsten-Fabric application policy set", + "description": "Tungsten-Fabric firewall policy name", "length": 255, - "name": "applicationpolicysetuuid", - "required": false, + "name": "name", + "required": true, "type": "string" }, { - "description": "the ID of zone", + "description": "the uuid of Tungsten-Fabric application policy set", "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, - "type": "uuid" + "name": "applicationpolicysetuuid", + "required": false, + "type": "string" } ], "related": "", "response": [ - {}, + { + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", + "type": "string" + }, + { + "description": "Tungsten-Fabric firewall policy name", + "name": "name", + "type": "string" + }, { "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", - "type": "string" + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "Tungsten-Fabric firewall policy name", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" - } + {} ] }, { @@ -93261,11 +93541,11 @@ "name": "updateRegion", "params": [ { - "description": "updates region with this end point", + "description": "Id of region to update", "length": 255, - "name": "endpoint", - "required": false, - "type": "string" + "name": "id", + "required": true, + "type": "integer" }, { "description": "updates region with this name", @@ -93275,29 +93555,23 @@ "type": "string" }, { - "description": "Id of region to update", + "description": "updates region with this end point", "length": 255, - "name": "id", - "required": true, - "type": "integer" + "name": "endpoint", + "required": false, + "type": "string" } ], "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 ID of the region", + "name": "id", + "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the region", + "name": "name", "type": "string" }, { @@ -93305,19 +93579,25 @@ "name": "jobstatus", "type": "integer" }, - { - "description": "the ID of the region", - "name": "id", - "type": "integer" - }, { "description": "the end point of the region", "name": "endpoint", "type": "string" }, { - "description": "the name of the region", - "name": "name", + "description": "true if security groups support is enabled, false otherwise", + "name": "portableipserviceenabled", + "type": "boolean" + }, + { + "description": "true if GSLB service is enabled in the region, false otherwise", + "name": "gslbserviceenabled", + "type": "boolean" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, {} @@ -93332,33 +93612,33 @@ "description": "traffic type id", "length": 255, "name": "id", - "related": "addTrafficType,updateTrafficType", + "related": "addTrafficType,listTrafficTypes,updateTrafficType", "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": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" } ], "since": "3.0.0" @@ -93392,281 +93672,58 @@ } ], "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" - } - ], - "since": "4.20.0" - }, - { - "description": "Lists a project's project role permissions", - "isasync": false, - "name": "listProjectRolePermissions", - "params": [ - { - "description": "ID of the project role", - "length": 255, - "name": "projectroleid", - "related": "listProjectRoles,updateProjectRole", - "required": false, - "type": "uuid" - }, - { - "description": "ID of the project", - "length": 255, - "name": "projectid", - "related": "createProject", - "required": true, - "type": "uuid" - } - ], - "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", - "type": "string" - }, - { - "description": "the permission type of the api name or wildcard rule, allow/deny", - "name": "permission", - "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", - "type": "string" - }, - { - "description": "the name of the project role to which the role permission belongs", - "name": "projectrolename", - "type": "string" - }, - { - "description": "the ID of the project role permission", - "name": "id", - "type": "string" - }, - { - "description": "the api name or wildcard rule", - "name": "rule", - "type": "string" - } - ], - "since": "4.15.0" - }, - { - "description": "Lists all LDAP configurations", - "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, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "If set to true, and no domainid specified, list all LDAP configurations irrespective of the linked domain", - "length": 255, - "name": "listall", - "required": false, - "since": "4.13.2", - "type": "boolean" - }, - { - "description": "linked domain", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains", - "required": false, - "type": "uuid" - }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - } - ], - "related": "addLdapConfiguration", - "response": [ - { - "description": "port the ldap server is running on", - "name": "port", - "type": "int" - }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "linked domain", - "name": "domainid", - "type": "string" - }, - { - "description": "name of the host running the ldap server", - "name": "hostname", - "type": "string" - }, - {} - ], - "since": "4.2.0" - }, - { - "description": "Creates a l2tp/ipsec remote access vpn", - "isasync": true, - "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", - "length": 255, - "name": "iprange", - "required": false, - "type": "string" - }, - { - "description": "public ip address id of the vpn server", - "length": 255, - "name": "publicipid", - "related": "associateIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", - "required": true, - "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", - "length": 255, - "name": "openfirewall", - "required": false, - "type": "boolean" - }, - { - "description": "an optional account for the VPN. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, - { - "description": "an optional field, whether to the display the vpn to the end user or not", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" - } - ], - "related": "listRemoteAccessVpns", - "response": [ - { - "description": "the account of the remote access vpn", - "name": "account", - "type": "string" - }, - { - "description": "the domain name of the account of the remote access vpn", - "name": "domain", - "type": "string" - }, - { - "description": "the public ip address of the vpn server", - "name": "publicipid", - "type": "string" - }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, + } + ], + "since": "4.20.0" + }, + { + "description": "Lists a project's project role permissions", + "isasync": false, + "name": "listProjectRolePermissions", + "params": [ { - "description": "the range of ips to allocate to the clients", - "name": "iprange", - "type": "string" + "description": "ID of the project role", + "length": 255, + "name": "projectroleid", + "related": "listProjectRoles,updateProjectRole", + "required": false, + "type": "uuid" }, { - "description": "the public ip address of the vpn server", - "name": "publicip", - "type": "string" - }, + "description": "ID of the project", + "length": 255, + "name": "projectid", + "related": "createProject", + "required": true, + "type": "uuid" + } + ], + "related": "", + "response": [ { - "description": "the project name of the vpn", - "name": "project", + "description": "the ID of the project", + "name": "projectid", "type": "string" }, { @@ -93675,407 +93732,351 @@ "type": "string" }, { - "description": "the ipsec preshared key", - "name": "presharedkey", + "description": "the ID of the project role permission", + "name": "id", "type": "string" }, { - "description": "the state of the rule", - "name": "state", + "description": "the api name or wildcard rule", + "name": "rule", "type": "string" }, { - "description": "path of the domain to which the remote access vpn belongs", - "name": "domainpath", + "description": "the permission type of the api name or wildcard rule, allow/deny", + "name": "permission", "type": "string" }, + {}, { - "description": "is vpn for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the name of the project role to which the role permission belongs", + "name": "projectrolename", + "type": "string" }, { - "description": "the domain id of the account of the remote access vpn", - "name": "domainid", + "description": "the ID of the project role to which the role permission belongs", + "name": "projectroleid", "type": "string" }, { - "description": "the id of the remote access vpn", - "name": "id", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "the description of the role permission", + "name": "description", "type": "string" - } - ] + }, + {} + ], + "since": "4.15.0" }, { - "description": "(This API is deprecated, use scaleVirtualMachine API)Changes the service offering for a virtual machine. The virtual machine must be in a \"Stopped\" state for this command to take effect.", + "description": "Lists all LDAP configurations", "isasync": false, - "name": "changeServiceForVirtualMachine", + "name": "listLdapConfigurations", "params": [ { - "description": "New maximum number of IOPS for the custom disk offering", + "description": "List by keyword", "length": 255, - "name": "maxiops", + "name": "keyword", "required": false, - "since": "4.17", - "type": "long" + "type": "string" }, { - "description": "Verify OK to Shrink", + "description": "linked domain", "length": 255, - "name": "shrinkok", + "name": "domainid", + "related": "createDomain,listDomains,listDomains", "required": false, - "since": "4.17", - "type": "boolean" + "type": "uuid" }, { - "description": "the service offering ID to apply to the virtual machine", + "description": "Port", "length": 255, - "name": "serviceofferingid", - "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", - "required": true, - "type": "uuid" + "name": "port", + "required": false, + "type": "integer" }, { - "description": "New minimum number of IOPS for the custom disk offering", + "description": "If set to true, and no domainid specified, list all LDAP configurations irrespective of the linked domain", "length": 255, - "name": "miniops", + "name": "listall", "required": false, - "since": "4.17", - "type": "long" + "since": "4.13.2", + "type": "boolean" }, { - "description": "Flag for automatic migration of the root volume with new compute offering whenever migration is required to apply the offering", + "description": "", "length": 255, - "name": "automigrate", + "name": "pagesize", "required": false, - "since": "4.17", - "type": "boolean" + "type": "integer" }, { - "description": "name value pairs of custom parameters for cpuspeed, memory and cpunumber. example details[i].name=value", + "description": "", "length": 255, - "name": "details", + "name": "page", "required": false, - "type": "map" + "type": "integer" }, { - "description": "The ID of the virtual machine", + "description": "list ldap configuration by ID; when passed, all other parameters are ignored", "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, + "related": "addLdapConfiguration,listLdapConfigurations", + "required": false, "type": "uuid" + }, + { + "description": "Hostname", + "length": 255, + "name": "hostname", + "required": false, + "type": "string" } ], - "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": "addLdapConfiguration", "response": [ { - "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", + "type": "integer" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "linked domain", + "name": "domainid", "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", - "type": "string" + "description": "port the ldap server is running on", + "name": "port", + "type": "int" }, + {}, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the ID of the LDAP configuration", + "name": "id", "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": "name of the host running the ldap server", + "name": "hostname", "type": "string" }, + {}, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - }, + } + ], + "since": "4.2.0" + }, + { + "description": "Creates a l2tp/ipsec remote access vpn", + "isasync": true, + "name": "createRemoteAccessVpn", + "params": [ { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", - "type": "string" + "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": "true if the entity/resource has annotations", - "name": "hasannotations", + "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": "the name of the domain in which the virtual machine exists", - "name": "domain", - "type": "string" - }, - { - "description": "the ID of the vgpu profile to which service offering is linked", - "name": "vgpuprofileid", - "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": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "an optional account for the VPN. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" - }, - { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "the 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 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": "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" - } - ], - "type": "set" + "description": "public ip address id of the vpn server", + "length": 255, + "name": "publicipid", + "related": "associateIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "required": true, + "type": "uuid" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "the range of ip addresses to allocate to vpn clients. The first ip in the range will be taken by the vpn server", + "length": 255, + "name": "iprange", + "required": false, "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" - }, + "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": "openfirewall", + "required": false, + "type": "boolean" + } + ], + "related": "listRemoteAccessVpns", + "response": [ { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the state of the rule", + "name": "state", "type": "string" }, { - "description": "the project name of the vm", - "name": "project", + "description": "the public ip address of the vpn server", + "name": "publicip", "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 domain id of the account of the remote access vpn", + "name": "domainid", "type": "string" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "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 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": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "the ipsec preshared key", + "name": "presharedkey", "type": "string" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "the id of the remote access vpn", + "name": "id", "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, + {}, + {}, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "the account of the remote access vpn", + "name": "account", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", + "description": "the public ip address of the vpn server", "name": "publicipid", "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", - "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 project name of the vpn", + "name": "project", "type": "string" }, { - "description": "Instance lease expiry date", - "name": "leaseexpirydate", - "type": "date" - }, - { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the range of ips to allocate to the clients", + "name": "iprange", "type": "string" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" - }, - { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "the domain name of the account of the remote access vpn", + "name": "domain", "type": "string" }, { - "description": "the 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": "true if vm has delete protection.", - "name": "deleteprotection", + "description": "is vpn for display to the regular user", + "name": "fordisplay", "type": "boolean" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "path of the domain to which the remote access vpn belongs", + "name": "domainpath", "type": "string" - }, + } + ] + }, + { + "description": "(This API is deprecated, use scaleVirtualMachine API)Changes the service offering for a virtual machine. The virtual machine must be in a \"Stopped\" state for this command to take effect.", + "isasync": false, + "name": "changeServiceForVirtualMachine", + "params": [ { - "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": "New minimum number of IOPS for the custom disk offering", + "length": 255, + "name": "miniops", + "required": false, + "since": "4.17", + "type": "long" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", + "description": "New maximum number of IOPS for the custom disk offering", + "length": 255, + "name": "maxiops", + "required": false, + "since": "4.17", "type": "long" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", + "description": "Verify OK to Shrink", + "length": 255, + "name": "shrinkok", + "required": false, + "since": "4.17", "type": "boolean" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", - "type": "string" + "description": "The ID of the virtual machine", + "length": 255, + "name": "id", + "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,createVMFromBackup,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "required": true, + "type": "uuid" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" + "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": "the name of the virtual machine", - "name": "name", - "type": "string" + "description": "the service offering ID to apply to the virtual machine", + "length": 255, + "name": "serviceofferingid", + "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", + "required": true, + "type": "uuid" }, { - "description": "the format of the template for the virtual machine", - "name": "templateformat", - "type": "string" - }, + "description": "Flag for automatic migration of the root volume with new compute offering whenever migration is required to apply the offering", + "length": 255, + "name": "automigrate", + "required": false, + "since": "4.17", + "type": "boolean" + } + ], + "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,createVMFromBackup,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "response": [ { "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 list of virtualmachine ids associated with this securitygroup", "name": "virtualmachineids", @@ -94087,47 +94088,104 @@ "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 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": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "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" + } + ], + "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 domain name of the security group", - "name": "domain", - "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 starting IP of the security group rule", - "name": "startport", + "description": "the code for the ICMP message response", + "name": "icmpcode", "type": "integer" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", + "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": "the starting IP of the security group rule", + "name": "startport", "type": "integer" }, { @@ -94135,23 +94193,23 @@ "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": "resource type", - "name": "resourcetype", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -94160,56 +94218,46 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "resource type", + "name": "resourcetype", "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": "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": "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 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 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": "security group name", - "name": "securitygroupname", + "description": "account owning the security group rule", + "name": "account", "type": "string" }, { @@ -94221,101 +94269,54 @@ "type": "set" }, { - "description": "the list of resource tags associated with the rule", - "name": "tags", + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", "response": [ { - "description": "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 starting IP of the security group rule", + "name": "startport", + "type": "integer" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "account owning the security group rule", + "name": "account", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", - "type": "string" + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" }, { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", - "type": "string" + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, - { - "description": "tag value", - "name": "value", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "the account owning the security group", - "name": "account", - "type": "string" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" - }, - { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", - "response": [ { "description": "the 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 list of resource tags associated with the rule", "name": "tags", @@ -94326,8 +94327,8 @@ "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -94336,8 +94337,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", "type": "string" }, { @@ -94350,16 +94356,6 @@ "name": "project", "type": "string" }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, { "description": "the ID of the domain associated with the tag", "name": "domainid", @@ -94374,167 +94370,235 @@ "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 CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" } ], "type": "set" }, + { + "description": "the project name of the group", + "name": "project", + "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 ID of the security group", + "name": "id", + "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 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 name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "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 ID of the virtual machine", - "name": "id", + "description": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" + }, + { + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", + "description": "VNF details", + "name": "vnfdetails", + "type": "map" + }, + { + "description": "the maximum Y resolution", + "name": "maxresolutiony", "type": "long" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "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 write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", "type": "string" }, { - "description": "the maximum Y resolution", - "name": "maxresolutiony", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" + }, + { + "description": "the read (IO) of disk on the VM", + "name": "diskioread", "type": "long" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "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": "the memory allocated for the virtual machine", - "name": "memory", + "description": "Instance lease duration in days", + "name": "leaseduration", "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 name of the template for the virtual machine", - "name": "templatename", + "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 ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" }, { "description": "the group name of the virtual machine", "name": "group", "type": "string" }, + { + "description": "the ID of the host for the virtual machine", + "name": "hostid", + "type": "string" + }, { "description": "public IP address id associated with vm via Static nat rule", "name": "publicip", "type": "string" }, { - "description": "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 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 account associated with the virtual machine", - "name": "account", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "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 target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, { "description": "the maximum X resolution", "name": "maxresolutionx", "type": "long" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the type of the template for the virtual machine", + "name": "templatetype", + "type": "string" }, { "description": " an alternate display text of the template for the virtual machine", @@ -94542,28 +94606,64 @@ "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "User VM type", - "name": "vmtype", + "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 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", + "type": "string" + }, + {}, + { + "description": "the project id of the vm", + "name": "projectid", + "type": "string" + }, + { + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", + "type": "string" + }, + { + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" + }, + { + "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": "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 maximum number of display heads", + "name": "maxheads", + "type": "long" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { @@ -94572,33 +94672,28 @@ "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "description": "the state of the virtual machine", - "name": "state", + "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": "CPU arch of the VM", + "name": "arch", + "type": "string" }, { - "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 incoming network traffic on the VM in KiB", - "name": "networkkbsread", + "description": "the video RAM size in MB", + "name": "videoram", "type": "long" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { @@ -94606,18 +94701,23 @@ "name": "nic", "response": [ { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { @@ -94626,23 +94726,33 @@ "type": "string" }, { - "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" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "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 traffic type of the nic", + "name": "traffictype", + "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": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { @@ -94651,23 +94761,33 @@ "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "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 netmask of the nic", - "name": "netmask", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { @@ -94676,18 +94796,18 @@ "type": "integer" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the type of the nic", + "name": "type", "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 name of the corresponding network", - "name": "networkname", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { @@ -94696,8 +94816,23 @@ "type": "integer" }, { - "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 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", "type": "string" }, { @@ -94706,157 +94841,305 @@ "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": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "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": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", + "type": "string" + }, + { + "description": "the VM's primary IP address", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "User VM type", + "name": "vmtype", + "type": "string" + }, + { + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "tag value", + "name": "value", "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": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" } ], "type": "set" }, {}, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "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", + "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 name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "the maximum number of display heads", - "name": "maxheads", - "type": "long" + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", + "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", + "description": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" + }, + { + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" + }, + {}, + { + "description": "the pool type of the virtual machine", + "name": "pooltype", + "type": "string" + }, + { + "description": "the memory used by the VM in KiB", + "name": "memorykbs", "type": "long" }, { - "description": "Instance lease expiry action", - "name": "leaseexpiryaction", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, + { + "description": "the project name of the vm", + "name": "project", "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", + "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "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 outgoing network traffic on the host in KiB", - "name": "networkkbswrite", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "type": "string" + }, + { + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" + }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", "type": "long" }, { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", + "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": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "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", + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, + { + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + { + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", "type": "long" }, + { + "description": "the id of userdata used for the VM", + "name": "userdataid", + "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 name of the virtual machine", + "name": "name", + "type": "string" + }, + { + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" + }, + { + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "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 project ID of the affinity group", "name": "projectid", "type": "string" }, + { + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" + }, { "description": "the project name of the affinity group", "name": "project", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" + "description": "the type of the affinity group", + "name": "type", + "type": "string" }, { "description": "the name of the affinity group", @@ -94864,30 +95147,20 @@ "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", + "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 domain name of the affinity group", - "name": "domain", + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", "type": "string" }, - { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", - "type": "list" - }, { "description": "the ID of the affinity group", "name": "id", @@ -94899,36 +95172,56 @@ "type": "string" }, { - "description": "the account owning the affinity group", - "name": "account", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" } ], "type": "set" }, { - "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": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the video RAM size in MB", - "name": "videoram", + "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" + }, + { + "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", + "description": "device ID of the root volume", + "name": "rootdeviceid", "type": "long" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "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" } ] @@ -94939,38 +95232,37 @@ "name": "listGuestOsMapping", "params": [ { - "description": "list mapping by Guest OS Type UUID", + "description": "list Guest OS mapping by OS mapping name with hypervisor", "length": 255, - "name": "ostypeid", - "related": "addGuestOs", + "name": "osnameforhypervisor", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list Guest OS mapping by hypervisor version. Must be used with hypervisor parameter", + "description": "list Guest OS mapping by OS display name", "length": 255, - "name": "hypervisorversion", + "name": "osdisplayname", "required": false, "type": "string" }, { - "description": "list Guest OS mapping by hypervisor", + "description": "list Guest OS mapping by hypervisor version. Must be used with hypervisor parameter", "length": 255, - "name": "hypervisor", + "name": "hypervisorversion", "required": false, "type": "string" }, { - "description": "list Guest OS mapping by OS display name", + "description": "List by keyword", "length": 255, - "name": "osdisplayname", + "name": "keyword", "required": false, "type": "string" }, { - "description": "list Guest OS mapping by OS mapping name with hypervisor", + "description": "list Guest OS mapping by hypervisor", "length": 255, - "name": "osnameforhypervisor", + "name": "hypervisor", "required": false, "type": "string" }, @@ -94982,19 +95274,20 @@ "type": "integer" }, { - "description": "list mapping by its UUID", + "description": "list mapping by Guest OS Type UUID", "length": 255, - "name": "id", - "related": "listGuestOsMapping,addGuestOsMapping,updateGuestOsMapping", + "name": "ostypeid", + "related": "addGuestOs", "required": false, "type": "uuid" }, { - "description": "List by keyword", + "description": "list mapping by its UUID", "length": 255, - "name": "keyword", + "name": "id", + "related": "listGuestOsMapping,addGuestOsMapping,updateGuestOsMapping", "required": false, - "type": "string" + "type": "uuid" }, { "description": "", @@ -95007,44 +95300,44 @@ "related": "addGuestOsMapping,updateGuestOsMapping", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the hypervisor", + "name": "hypervisor", "type": "string" }, { - "description": "the ID of the Guest OS mapping", - "name": "id", + "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" }, - {}, { - "description": "the ID of the Guest OS type", - "name": "ostypeid", + "description": "is the mapping user defined", + "name": "isuserdefined", "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": "version of the hypervisor for mapping", - "name": "hypervisorversion", + "description": "the ID of the Guest OS mapping", + "name": "id", "type": "string" }, { - "description": "is the mapping user defined", - "name": "isuserdefined", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the hypervisor", - "name": "hypervisor", + "description": "version of the hypervisor for mapping", + "name": "hypervisorversion", "type": "string" }, {}, @@ -95062,75 +95355,59 @@ "name": "listTemplates", "params": [ { - "description": "list templates by zoneId", + "description": "ID of the extension for the template", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "extensionid", + "related": "listExtensions,deleteExtension,updateExtension,unregisterExtension", "required": false, + "since": "4.21.0", "type": "uuid" }, { - "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": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "ID of the image or image cache store", + "description": "list templates by zoneId", "length": 255, - "name": "imagestoreid", - "related": "addSecondaryStorage,listSwifts,addImageStore", + "name": "zoneid", + "related": "listZones", "required": false, - "since": "4.19", "type": "uuid" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, - { - "description": "If set to true, list only unique templates across zones", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "showunique", + "name": "isrecursive", "required": false, - "since": "4.13.2", "type": "boolean" }, { - "description": "the template ID", + "description": "list objects by project; if projectid=-1 lists All VMs", "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", + "name": "projectid", + "related": "createProject", "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,listDomains,listDomains", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "the type of the template", "length": 255, - "name": "projectid", - "related": "createProject", + "name": "templatetype", "required": false, - "type": "uuid" + "since": "4.19.0", + "type": "string" }, { "description": "", @@ -95140,11 +95417,20 @@ "type": "integer" }, { - "description": "the hypervisor for which to restrict the search", + "description": "If set to true, list only unique templates across zones", "length": 255, - "name": "hypervisor", + "name": "showunique", "required": false, - "type": "string" + "since": "4.13.2", + "type": "boolean" + }, + { + "description": "flag to list VNF templates or not; true if need to list VNF templates, false otherwise.", + "length": 255, + "name": "isvnf", + "required": false, + "since": "4.19.0", + "type": "boolean" }, { "description": "the template name", @@ -95154,33 +95440,39 @@ "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "ID of the image or image cache store", "length": 255, - "name": "account", + "name": "imagestoreid", + "related": "addSecondaryStorage,listSwifts,addImageStore", "required": false, - "type": "string" + "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": "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": "list templates that can be used to deploy CKS clusters", + "description": "the IDs of the templates, mutually exclusive with id", "length": 255, - "name": "forcks", + "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, - "since": "4.21.0", - "type": "boolean" + "since": "4.9", + "type": "list" }, { - "description": "show removed templates as well", + "description": "list datadisk templates by parent template id", "length": 255, - "name": "showremoved", + "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": "boolean" + "since": "4.4", + "type": "uuid" }, { "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", @@ -95198,35 +95490,35 @@ "type": "string" }, { - "description": "the type of the template", + "description": "List by keyword", "length": 255, - "name": "templatetype", + "name": "keyword", "required": false, - "since": "4.19.0", "type": "string" }, { - "description": "flag to display the resource image for the templates", + "description": "the hypervisor for which to restrict the search", "length": 255, - "name": "showicon", + "name": "hypervisor", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "ID of the storage pool", + "description": "the template ID", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", + "name": "id", + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", "required": false, - "since": "4.19", "type": "uuid" }, { - "description": "List resources by tags (key/value pairs)", + "description": "the ID of the OS category for the template", "length": 255, - "name": "tags", + "name": "oscategoryid", + "related": "listOsCategories", "required": false, - "type": "map" + "since": "4.21.0", + "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).", @@ -95236,133 +95528,110 @@ "type": "string" }, { - "description": "list templates that are ready to be deployed", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "isready", + "name": "tags", + "required": false, + "type": "map" + }, + { + "description": "list templates that can be used to deploy CKS clusters", + "length": 255, + "name": "forcks", "required": false, "since": "4.21.0", "type": "boolean" }, { - "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", + "description": "ID of the storage pool", "length": 255, - "name": "oscategoryid", - "related": "listOsCategories", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", "required": false, - "since": "4.21.0", + "since": "4.19", "type": "uuid" }, { - "description": "comma separated list of template details requested, value can be a list of [ all, min]", + "description": "show removed templates as well", "length": 255, - "name": "details", + "name": "showremoved", "required": false, - "since": "4.15", - "type": "list" + "type": "boolean" }, { - "description": "list datadisk templates by parent template id", + "description": "comma separated list of template details requested, value can be a list of [ all, min]", "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": "details", "required": false, - "since": "4.4", - "type": "uuid" + "since": "4.15", + "type": "list" }, { - "description": "ID of the extension for the template", + "description": "", "length": 255, - "name": "extensionid", - "related": "listExtensions,deleteExtension,updateExtension,unregisterExtension", + "name": "pagesize", "required": false, - "since": "4.21.0", - "type": "uuid" + "type": "integer" } ], - "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", "response": [ + { + "description": "the name of the secondary storage host for the template", + "name": "hostname", + "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": "the template name", - "name": "name", - "type": "string" - }, - { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", "type": "boolean" }, { - "description": "checksum of the template", - "name": "checksum", - "type": "string" - }, - { - "description": "the template display text", - "name": "displaytext", - "type": "string" - }, - { - "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 the template is ready to be deployed from, false otherwise.", + "name": "isready", "type": "boolean" }, { - "description": "the project name of the template", - "name": "project", - "type": "string" + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" }, { - "description": "the account id to which the template belongs", - "name": "accountid", + "description": "the account name to which the template belongs", + "name": "account", "type": "string" }, { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" - }, - { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", - "type": "boolean" + "description": "The ID of extension linked to this template", + "name": "extensionid", + "type": "string" }, + {}, { - "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": "true if the template is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "the processor bit size", + "name": "bits", + "type": "int" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", "type": "boolean" }, { @@ -95370,18 +95639,18 @@ "name": "tags", "response": [ { - "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": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -95390,8 +95659,8 @@ "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -95400,47 +95669,42 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "tag value", + "name": "value", "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": "resource type", - "name": "resourcetype", + "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": "customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "set" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "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 userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" + "description": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" }, { "description": "the status of the template", @@ -95448,202 +95712,231 @@ "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 is sshkey enabled, false otherwise", + "name": "sshkeyenabled", + "type": "boolean" + }, + { + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", "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": "additional key/value details tied with template", - "name": "details", - "type": "map" + "description": "the ID of the zone for this template", + "name": "zoneid", + "type": "string" }, { - "description": "the name of the secondary storage host for the template", - "name": "hostname", + "description": "the name of the domain to which the template belongs", + "name": "domain", "type": "string" }, { - "description": "the type of the template", - "name": "templatetype", + "description": "the tag of this template", + "name": "templatetag", "type": "string" }, { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", + "description": "the URL which the template/iso is registered from", + "name": "url", "type": "string" }, + {}, { "description": "the id of userdata linked to this template", "name": "userdataid", "type": "string" }, { - "description": "CPU Arch of the template", - "name": "arch", + "description": "the name of the OS type for this template.", + "name": "ostypename", "type": "string" }, { - "description": "The name of extension linked to this template", - "name": "extensionname", + "description": "the ID of the domain to which the template belongs", + "name": "domainid", "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 ID of the domain to which the template belongs", - "name": "domainid", + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", "type": "string" }, { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", + "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": "path of the Domain the template belongs to", + "name": "domainpath", + "type": "string" }, { - "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": "the processor bit size", - "name": "bits", - "type": "int" + "description": "the name of the zone for this template", + "name": "zonename", + "type": "string" }, { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", + "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 OS type for this template.", - "name": "ostypeid", + "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", - "type": "boolean" + "description": "checksum of the template", + "name": "checksum", + "type": "string" }, { - "description": "the name of userdata linked to this template", - "name": "userdataname", + "description": "the size of the template", + "name": "size", + "type": "long" + }, + { + "description": "the template ID", + "name": "id", "type": "string" }, - {}, { - "description": "the name of the domain to which the template belongs", - "name": "domain", + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", + "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": "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { "description": "the date this template was created", "name": "created", "type": "date" }, { - "description": "the 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": "The ID of extension linked to this template", - "name": "extensionid", + "description": "the template name", + "name": "name", "type": "string" }, { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", + "type": "boolean" }, - {}, { - "description": "the size of the template", - "name": "size", + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", + "type": "boolean" + }, + { + "description": "the physical size of the template", + "name": "physicalsize", "type": "long" }, { - "description": "the account name to which the template belongs", - "name": "account", + "description": "the name of userdata linked to this template", + "name": "userdataname", "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 tag of this template", - "name": "templatetag", + "description": "the template display text", + "name": "displaytext", + "type": "string" + }, + { + "description": "the ID of the OS type for this template.", + "name": "ostypeid", + "type": "string" + }, + { + "description": "the project id of the template", + "name": "projectid", "type": "string" }, + {}, { - "description": "the ID of the zone for this template", - "name": "zoneid", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the template ID", - "name": "id", + "description": "the project name of the template", + "name": "project", "type": "string" }, { - "description": "the name of the zone for this template", - "name": "zonename", - "type": "string" + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" }, { - "description": "the physical size of the template", - "name": "physicalsize", - "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": "The name of extension linked to this template", + "name": "extensionname", + "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": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the project id of the template", - "name": "projectid", - "type": "string" + "description": "the format of the template.", + "name": "format", + "type": "imageformat" }, { - "description": "path of the Domain the template belongs to", - "name": "domainpath", - "type": "string" + "description": "If true it indicates that the template can be used for CKS cluster deployments", + "name": "forcks", + "type": "boolean" } ] }, @@ -95670,19 +95963,22 @@ ], "related": "listTungstenFabricPolicy", "response": [ - {}, + { + "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", @@ -95693,20 +95989,17 @@ "name": "zonename", "type": "string" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, + {}, { "description": "Tungsten-Fabric provider zone id", "name": "zoneid", "type": "long" }, + {}, { - "description": "list Tungsten-Fabric policy network name", - "name": "network", - "type": "list" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ] }, @@ -95725,27 +96018,27 @@ } ], "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, + {}, + {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, - {}, { "description": "the current status of the latest 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,41 +96049,33 @@ "name": "createBucket", "params": [ { - "description": "Enable object locking in bucket", + "description": "the account associated with the bucket. Must be used with the domainId parameter.", "length": 255, - "name": "objectlocking", + "name": "account", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "Bucket Quota in GiB", + "description": "Id of the Object Storage Pool where bucket is created", "length": 255, - "name": "quota", + "name": "objectstorageid", + "related": "addObjectStoragePool", "required": true, - "type": "integer" + "type": "uuid" }, { - "description": "Enable bucket encryption", + "description": "Enable object locking in bucket", "length": 255, - "name": "encryption", + "name": "objectlocking", "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, - "name": "domainid", - "related": "createDomain,listDomains,listDomains", - "required": false, - "type": "uuid" - }, - { - "description": "the project associated with the bucket. Mutually exclusive with account parameter", + "description": "Enable bucket encryption", "length": 255, - "name": "projectid", - "related": "createProject", + "name": "encryption", "required": false, - "type": "uuid" + "type": "boolean" }, { "description": "the name of the bucket", @@ -95800,12 +96085,11 @@ "type": "string" }, { - "description": "Id of the Object Storage Pool where bucket is created", + "description": "Enable bucket versioning", "length": 255, - "name": "objectstorageid", - "related": "addObjectStoragePool", - "required": true, - "type": "uuid" + "name": "versioning", + "required": false, + "type": "boolean" }, { "description": "The Bucket access policy", @@ -95815,79 +96099,105 @@ "type": "string" }, { - "description": "the account associated with the bucket. Must be used with the domainId parameter.", + "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, - "name": "account", + "name": "domainid", + "related": "createDomain,listDomains,listDomains", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "Enable bucket versioning", + "description": "the project associated with the bucket. Mutually exclusive with account parameter", "length": 255, - "name": "versioning", + "name": "projectid", + "related": "createProject", "required": false, - "type": "boolean" + "type": "uuid" + }, + { + "description": "Bucket Quota in GiB", + "length": 255, + "name": "quota", + "required": true, + "type": "integer" } ], "related": "listBuckets", "response": [ { - "description": "name of the Bucket", - "name": "name", + "description": "ID of the Bucket", + "name": "id", "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", + "description": "path of the domain to which the bucket belongs", + "name": "domainpath", + "type": "string" + }, + { + "description": "Bucket Quota in GiB", + "name": "quota", + "type": "integer" + }, + { + "description": "the ID of the domain associated with the bucket", + "name": "domainid", + "type": "string" + }, + { + "description": "Name of the object storage hosting the Bucket; returned to admin user only", + "name": "objectstore", + "type": "string" + }, + { + "description": "Bucket Encryption", + "name": "encryption", "type": "boolean" }, + {}, + {}, { - "description": "the date the Bucket was created", - "name": "created", - "type": "date" + "description": "Bucket Access Key", + "name": "accesskey", + "type": "string" }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "tag key name", - "name": "key", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "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 value", - "name": "value", + "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" }, { @@ -95901,47 +96211,27 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "resource type", + "name": "resourcetype", "type": "string" } ], "type": "set" }, { - "description": "Object storage provider", - "name": "provider", - "type": "string" - }, - { - "description": "Bucket Access Policy", - "name": "policy", - "type": "string" - }, - { - "description": "the project name of the bucket", - "name": "project", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "Bucket Encryption", - "name": "encryption", - "type": "boolean" + "description": "the date the Bucket was created", + "name": "created", + "type": "date" }, { "description": "Bucket URL", @@ -95949,25 +96239,23 @@ "type": "string" }, { - "description": "Bucket Quota in GiB", - "name": "quota", - "type": "integer" + "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": "id of the object storage hosting the Bucket; returned to admin user only", + "name": "objectstorageid", + "type": "string" }, - {}, { - "description": "path of the domain to which the bucket belongs", - "name": "domainpath", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "Bucket Access Key", - "name": "accesskey", + "description": "Bucket Access Policy", + "name": "policy", "type": "string" }, { @@ -95976,49 +96264,54 @@ "type": "string" }, { - "description": "Name of the object storage hosting the Bucket; returned to admin user only", - "name": "objectstore", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the domain associated with the bucket", - "name": "domain", + "description": "State of the Bucket", + "name": "state", "type": "string" }, { - "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": "ID of the Bucket", - "name": "id", + "description": "the project name of the bucket", + "name": "project", "type": "string" }, { - "description": "the ID of the domain associated with the bucket", - "name": "domainid", - "type": "string" + "description": "Bucket Object Locking", + "name": "objectlocking", + "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": "Bucket Secret Key", + "name": "usersecretkey", "type": "string" }, { - "description": "Bucket Secret Key", - "name": "usersecretkey", + "description": "the domain associated with the bucket", + "name": "domain", "type": "string" }, { - "description": "State of the Bucket", - "name": "state", + "description": "Object storage provider", + "name": "provider", "type": "string" + }, + { + "description": "Total size of objects in Bucket", + "name": "size", + "type": "long" } ], "since": "4.19.0" @@ -96029,19 +96322,26 @@ "name": "listPhysicalNetworks", "params": [ { - "description": "the Zone ID for the physical network", + "description": "", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" + }, + { + "description": "the Zone ID for the physical network", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" }, { "description": "list physical network by id", @@ -96059,51 +96359,38 @@ "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" } ], "related": "updatePhysicalNetwork", "response": [ - {}, { - "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 domain id of the physical network owner", - "name": "domainid", + "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": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Broadcast domain range of the physical network", + "name": "broadcastdomainrange", "type": "string" }, { - "description": "the speed of the physical network", - "name": "networkspeed", + "description": "the uuid of the physical network", + "name": "id", "type": "string" }, { - "description": "the uuid of the physical network", - "name": "id", + "description": "the vlan of the physical network", + "name": "vlan", "type": "string" }, { @@ -96111,25 +96398,35 @@ "name": "tags", "type": "string" }, + { + "description": "zone name of the physical network", + "name": "zonename", + "type": "string" + }, { "description": "isolation methods", "name": "isolationmethods", "type": "string" }, { - "description": "name of the physical network", - "name": "name", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the domain id of the physical network owner", + "name": "domainid", "type": "string" }, {}, { - "description": "Broadcast domain range of the physical network", - "name": "broadcastdomainrange", + "description": "zone id of the physical network", + "name": "zoneid", "type": "string" }, { - "description": "zone name of the physical network", - "name": "zonename", + "description": "the speed of the physical network", + "name": "networkspeed", "type": "string" }, { @@ -96137,11 +96434,7 @@ "name": "state", "type": "string" }, - { - "description": "the vlan of the physical network", - "name": "vlan", - "type": "string" - } + {} ], "since": "3.0.0" }, @@ -96151,63 +96444,56 @@ "name": "listFirewallRules", "params": [ { - "description": "the ID of IP address of the firewall services", + "description": "Lists rule with the specified ID.", "length": 255, - "name": "ipaddressid", - "related": "associateIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "name": "id", + "related": "listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule", "required": false, "type": "uuid" }, { - "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": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "List resources by tags (key/value pairs)", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "tags", + "name": "fordisplay", "required": false, - "type": "map" + "since": "4.4", + "type": "boolean" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "fordisplay", + "name": "listall", "required": false, - "since": "4.4", "type": "boolean" }, { - "description": "list firewall rules for certain network", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "networkid", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", + "name": "domainid", + "related": "createDomain,listDomains,listDomains", "required": false, - "since": "4.3", "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": "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" }, @@ -96218,13 +96504,6 @@ "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", "length": 255, @@ -96234,62 +96513,95 @@ "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": "Lists rule with the specified ID.", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "id", - "related": "listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule", + "name": "tags", + "required": false, + "type": "map" + }, + { + "description": "the ID of IP address of the firewall services", + "length": 255, + "name": "ipaddressid", + "related": "associateIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", "required": false, "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" } ], "related": "createFirewallRule,updateEgressFirewallRule", "response": [ { - "description": "the public ip address for the firewall rule", - "name": "ipaddress", + "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 cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", "name": "cidrlist", "type": "string" }, - {}, { - "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": "is rule for display to the regular user", - "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 public ip address id for the firewall rule", + "name": "ipaddressid", + "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": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "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 ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -96298,102 +96610,83 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "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 project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the domain associated with the tag", + "name": "domain", "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": "tag value", + "name": "value", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "customer associated with the tag", + "name": "customer", "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", - "type": "string" - }, - { - "description": "the ending port of firewall rule's port range", - "name": "endport", - "type": "integer" - }, { "description": "the traffic type for the firewall rule", "name": "traffictype", "type": "string" }, + {}, { - "description": "the starting port of firewall rule's port range", - "name": "startport", - "type": "integer" + "description": "the protocol of the firewall rule", + "name": "protocol", + "type": "string" }, { "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", - "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 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" } ] }, @@ -96413,26 +96706,26 @@ ], "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", "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" } ] }, @@ -96442,18 +96735,19 @@ "name": "listRoutingFirewallRules", "params": [ { - "description": "List resources by tags (key/value pairs)", + "description": "Lists Routing firewall rule with the specified ID", "length": 255, - "name": "tags", + "name": "id", + "related": "listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule", "required": false, - "type": "map" + "type": "uuid" }, { - "description": "", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "page", + "name": "listall", "required": false, - "type": "integer" + "type": "boolean" }, { "description": "list Routing firewall rules by traffic type - ingress or egress", @@ -96462,13 +96756,6 @@ "required": false, "type": "string" }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, { "description": "list only resources belonging to the domain specified", "length": 255, @@ -96478,34 +96765,41 @@ "type": "uuid" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "projectid", - "related": "createProject", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "Lists Routing firewall rule with the specified ID", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "id", - "related": "listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule", + "name": "tags", "required": false, - "type": "uuid" + "type": "map" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "", "length": 255, - "name": "isrecursive", + "name": "pagesize", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "listall", + "name": "projectid", + "related": "createProject", "required": false, - "type": "boolean" + "type": "uuid" + }, + { + "description": "list Routing firewall rules by network ID", + "length": 255, + "name": "networkid", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", + "required": false, + "type": "uuid" }, { "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", @@ -96515,24 +96809,23 @@ "type": "boolean" }, { - "description": "list Routing firewall rules by network ID", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "networkid", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", + "name": "isrecursive", "required": false, - "type": "uuid" + "type": "boolean" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "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" } @@ -96544,18 +96837,28 @@ "name": "state", "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -96563,24 +96866,19 @@ "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", + "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" }, { @@ -96589,26 +96887,36 @@ "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "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", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "list" }, { - "description": "the ending port of port forwarding rule's private port range", - "name": "privateendport", + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { @@ -96617,34 +96925,40 @@ "type": "string" }, { - "description": "the vm ip address for the port forwarding rule", - "name": "vmguestip", + "description": "the public ip address for the port forwarding rule", + "name": "ipaddress", "type": "string" }, {}, + { + "description": "the public ip address id for the port forwarding rule", + "name": "ipaddressid", + "type": "string" + }, { "description": "the VM display name for the port forwarding rule", "name": "virtualmachinedisplayname", "type": "string" }, { - "description": "the 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 cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the vm ip address for the port forwarding rule", + "name": "vmguestip", "type": "string" }, + {}, { - "description": "is firewall for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the id of the guest network the port forwarding rule belongs to", + "name": "networkid", + "type": "string" }, { - "description": "the starting port of port forwarding rule's private port range", - "name": "privateport", + "description": "the ending port of port forwarding rule's private port range", + "name": "publicendport", "type": "string" }, { @@ -96658,8 +96972,8 @@ "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" }, { @@ -96667,31 +96981,10 @@ "name": "virtualmachinename", "type": "string" }, - { - "description": "the public ip address id for the port forwarding rule", - "name": "ipaddressid", - "type": "string" - }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "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": "publicendport", - "type": "string" - }, - { - "description": "the id of the guest network the port forwarding rule belongs to", - "name": "networkid", - "type": "string" } ], "since": "4.20.0" @@ -96701,18 +96994,11 @@ "isasync": true, "name": "extractIso", "params": [ - { - "description": "the URL to which the ISO would be extracted", - "length": 2048, - "name": "url", - "required": false, - "type": "string" - }, { "description": "the ID of the ISO file", "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": true, "type": "uuid" }, @@ -96724,6 +97010,13 @@ "required": false, "type": "uuid" }, + { + "description": "the URL to which the ISO would be extracted", + "length": 2048, + "name": "url", + "required": false, + "type": "string" + }, { "description": "the mode of extraction - HTTP_DOWNLOAD or FTP_UPLOAD", "length": 255, @@ -96732,21 +97025,16 @@ "type": "string" } ], - "related": "extractSnapshot,extractTemplate,downloadImageStoreObject", + "related": "downloadImageStoreObject,extractSnapshot,extractTemplate", "response": [ { - "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 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 mode of extraction - upload or download", + "name": "extractMode", "type": "string" }, { @@ -96755,20 +97043,18 @@ "type": "string" }, { - "description": "the name of the extracted object", - "name": "name", + "description": "the upload id of extracted object", + "name": "extractId", "type": "string" }, { - "description": "the id of extracted object", - "name": "id", + "description": "the status of the extraction", + "name": "status", "type": "string" }, - {}, - {}, { - "description": "the status of the extraction", - "name": "status", + "description": "the name of the extracted object", + "name": "name", "type": "string" }, { @@ -96776,19 +97062,20 @@ "name": "created", "type": "date" }, + {}, { - "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": "type of the storage", - "name": "storagetype", + "description": "the account id to which the extracted object belongs", + "name": "accountid", "type": "string" }, { - "description": "the upload id of extracted object", - "name": "extractId", + "description": "zone ID the object was extracted from", + "name": "zoneid", "type": "string" }, { @@ -96796,11 +97083,6 @@ "name": "state", "type": "string" }, - { - "description": "the mode of extraction - upload or download", - "name": "extractMode", - "type": "string" - }, { "description": "the percentage of the entity uploaded to the specified location", "name": "uploadpercentage", @@ -96812,8 +97094,19 @@ "type": "string" }, { - "description": "the account id to which the extracted object belongs", - "name": "accountid", + "description": "the id of extracted object", + "name": "id", + "type": "string" + }, + { + "description": "zone name the object was extracted from", + "name": "zonename", + "type": "string" + }, + {}, + { + "description": "type of the storage", + "name": "storagetype", "type": "string" } ] @@ -96831,17 +97124,10 @@ "type": "string" }, { - "description": "name of the affinity group", - "length": 255, - "name": "name", - "required": true, - "type": "string" - }, - { - "description": "domainId of the account owning the affinity group", + "description": "create affinity group for project", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains", + "name": "projectid", + "related": "createProject", "required": false, "type": "uuid" }, @@ -96853,10 +97139,17 @@ "type": "string" }, { - "description": "create affinity group for project", + "description": "name of the affinity group", "length": 255, - "name": "projectid", - "related": "createProject", + "name": "name", + "required": true, + "type": "string" + }, + { + "description": "domainId of the account owning the affinity group", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomains,listDomains", "required": false, "type": "uuid" }, @@ -96871,21 +97164,15 @@ "related": "", "response": [ { - "description": "the description of the affinity group", - "name": "description", - "type": "string" - }, - { - "description": "the ID of the affinity group", - "name": "id", + "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the name of the affinity group", @@ -96893,23 +97180,28 @@ "type": "string" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "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 description of the affinity group", + "name": "description", + "type": "string" }, { - "description": "the account owning the affinity group", - "name": "account", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "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" }, { @@ -96918,29 +97210,30 @@ "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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project name of the affinity group", + "name": "project", "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 affinity group", - "name": "project", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { "description": "the domain name of the affinity group", "name": "domain", "type": "string" + }, + { + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" } ] }, @@ -96949,6 +97242,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,26 +97257,19 @@ "type": "long" }, { - "description": "Email id with which user tried to login using OAuth provider", + "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": "email", - "required": true, + "name": "domain", + "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" }, - { - "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": "Code that is provided by OAuth provider (Eg. google, github) after successful login", "length": 255, @@ -96988,65 +97281,49 @@ "related": "", "response": [ { - "description": "the time period before the session has expired", - "name": "timeout", - "type": "integer" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "Username", - "name": "username", + "description": "Is user registered", + "name": "registered", "type": "string" }, { - "description": "user time zoneoffset", - "name": "timezoneoffset", + "description": "Is two factor authentication verified", + "name": "is2faverified", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "Two factor authentication issuer", - "name": "issuerfor2fa", + "description": "Management Server ID that the user logged to", + "name": "managementserverid", "type": "string" }, { - "description": "Is two factor authentication enabled", - "name": "is2faenabled", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "Two factor authentication provider", - "name": "providerfor2fa", + "description": "Domain ID that the user belongs to", + "name": "domainid", "type": "string" }, {}, { - "description": "the account name the user belongs to", - "name": "account", + "description": "Is two factor authentication enabled", + "name": "is2faenabled", "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": "first name of the user", + "name": "firstname", "type": "string" }, { - "description": "Management Server ID that the user logged to", - "name": "managementserverid", + "description": "Two factor authentication provider", + "name": "providerfor2fa", "type": "string" }, { @@ -97055,18 +97332,24 @@ "type": "string" }, { - "description": "the account type (admin, domain-admin, read-only-admin, user)", - "name": "type", + "description": "user time zone", + "name": "timezone", "type": "string" }, { - "description": "first name of the user", - "name": "firstname", + "description": "user time zoneoffset", + "name": "timezoneoffset", "type": "string" }, { - "description": "user time zone", - "name": "timezone", + "description": "Two factor authentication issuer", + "name": "issuerfor2fa", + "type": "string" + }, + {}, + { + "description": "last name of the user", + "name": "lastname", "type": "string" }, { @@ -97075,14 +97358,24 @@ "type": "string" }, { - "description": "Is user registered", - "name": "registered", + "description": "the time period before the session has expired", + "name": "timeout", + "type": "integer" + }, + { + "description": "Username", + "name": "username", "type": "string" }, { - "description": "last name of the user", - "name": "lastname", + "description": "the account name the user belongs to", + "name": "account", "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ], "since": "4.19.0" @@ -97099,21 +97392,6 @@ "required": false, "type": "boolean" }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, - { - "description": "list internal load balancer elements by id", - "length": 255, - "name": "id", - "related": "listInternalLoadBalancerElements", - "required": false, - "type": "uuid" - }, { "description": "", "length": 255, @@ -97132,9 +97410,24 @@ "description": "list internal load balancer elements by network service provider id", "length": 255, "name": "nspid", - "related": "addNetworkServiceProvider,listTrafficTypes", + "related": "addNetworkServiceProvider", + "required": false, + "type": "uuid" + }, + { + "description": "list internal load balancer elements by id", + "length": 255, + "name": "id", + "related": "listInternalLoadBalancerElements", "required": false, "type": "uuid" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" } ], "related": "", @@ -97146,14 +97439,8 @@ }, {}, { - "description": "the physical network service provider id of the element", - "name": "nspid", - "type": "string" - }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the id of the internal load balancer element", + "name": "id", "type": "string" }, { @@ -97162,8 +97449,14 @@ "type": "integer" }, { - "description": "the id of the internal load balancer element", - "name": "id", + "description": "the physical network service provider id of the element", + "name": "nspid", + "type": "string" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ], @@ -97175,10 +97468,10 @@ "name": "getHypervisorGuestOsNames", "params": [ { - "description": "Hypervisor type. One of : VMware, XenServer", + "description": "Keyword for guest os name", "length": 255, - "name": "hypervisor", - "required": true, + "name": "keyword", + "required": false, "type": "string" }, { @@ -97189,15 +97482,31 @@ "type": "string" }, { - "description": "Keyword for guest os name", + "description": "Hypervisor type. One of : VMware, XenServer", "length": 255, - "name": "keyword", - "required": false, + "name": "hypervisor", + "required": true, "type": "string" } ], "related": "", "response": [ + {}, + { + "description": "the hypervisor", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the guest OS count of the hypervisor", + "name": "guestoscount", + "type": "integer" + }, { "description": "version of the hypervisor for guest os names", "name": "hypervisorversion", @@ -97213,34 +97522,18 @@ "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" - }, {} ], "since": "4.19.0" @@ -97258,23 +97551,30 @@ "type": "string" }, { - "description": "Tungsten-Fabric provider name", + "description": "Tungsten-Fabric provider port", "length": 255, - "name": "name", + "name": "tungstenproviderport", + "required": false, + "type": "string" + }, + { + "description": "Tungsten-Fabric provider hostname", + "length": 255, + "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", + "description": "Tungsten-Fabric provider name", "length": 255, - "name": "tungstenproviderhostname", + "name": "name", "required": true, "type": "string" }, @@ -97286,13 +97586,6 @@ "required": true, "type": "uuid" }, - { - "description": "Tungsten-Fabric provider introspect port", - "length": 255, - "name": "tungstenproviderintrospectport", - "required": false, - "type": "string" - }, { "description": "Tungsten-Fabric provider vrouter port", "length": 255, @@ -97304,28 +97597,34 @@ "related": "", "response": [ { - "description": "Tungsten-Fabric provider uuid", - "name": "tungstenprovideruuid", + "description": "Tungsten-Fabric provider port", + "name": "tungstenproviderport", "type": "string" }, { - "description": "true if security groups support is enabled, false otherwise", - "name": "securitygroupsenabled", - "type": "boolean" + "description": "Tungsten-Fabric provider vrouter port", + "name": "tungstenprovidervrouterport", + "type": "string" }, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "Tungsten-Fabric provider introspect port", + "name": "tungstenproviderintrospectport", "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "Tungsten-Fabric provider vrouter port", - "name": "tungstenprovidervrouterport", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, { @@ -97333,23 +97632,7 @@ "name": "tungstengateway", "type": "string" }, - { - "description": "Tungsten-Fabric provider port", - "name": "tungstenproviderport", - "type": "string" - }, {}, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "Tungsten-Fabric provider introspect port", - "name": "tungstenproviderintrospectport", - "type": "string" - }, { "description": "Tungsten-Fabric provider name", "name": "name", @@ -97360,6 +97643,16 @@ "name": "zoneid", "type": "long" }, + { + "description": "true if security groups support is enabled, false otherwise", + "name": "securitygroupsenabled", + "type": "boolean" + }, + { + "description": "Tungsten-Fabric provider uuid", + "name": "tungstenprovideruuid", + "type": "string" + }, { "description": "Tungsten-Fabric provider hostname", "name": "tungstenproviderhostname", @@ -97368,18 +97661,50 @@ ] }, { - "description": "Reboots a virtual machine.", + "description": "Enables HA cluster-wide", "isasync": true, - "name": "rebootVirtualMachine", + "name": "enableHAForCluster", "params": [ { - "description": "Force reboot the VM (VM is Stopped and then Started)", + "description": "ID of the cluster", "length": 255, - "name": "forced", - "required": false, - "since": "4.16.0", + "name": "clusterid", + "related": "addCluster,updateCluster", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, + {}, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ], + "since": "4.11" + }, + { + "description": "Reboots a virtual machine.", + "isasync": true, + "name": "rebootVirtualMachine", + "params": [ { "description": "Boot into hardware setup menu or not", "length": 255, @@ -97388,272 +97713,155 @@ "since": "4.15.0.0", "type": "boolean" }, + { + "description": "Force reboot the VM (VM is Stopped and then Started)", + "length": 255, + "name": "forced", + "required": false, + "since": "4.16.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", + "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,createVMFromBackup,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "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,createVMFromBackup,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "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 maximum X resolution", - "name": "maxresolutionx", - "type": "long" - }, - { - "description": "the name of the host for the virtual machine", - "name": "hostname", - "type": "string" - }, - { - "description": "the state of the virtual machine", - "name": "state", - "type": "string" - }, - { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" - }, - { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "User VM type", + "name": "vmtype", "type": "string" }, { - "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": "Instance lease expiry action", - "name": "leaseexpiryaction", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, - { - "description": "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": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "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": "publicip", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", - "type": "string" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "the list of nics associated with vm", - "name": "nic", + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", "response": [ { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", "type": "list" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "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": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "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": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "the ID of the nic", + "description": "the ID of the affinity group", "name": "id", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", "type": "list" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "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", + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "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 description of the affinity group", + "name": "description", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the type of the affinity group", + "name": "type", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "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 virtual machine", + "name": "id", "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": "the project name of the vm", - "name": "project", - "type": "string" + "description": "the maximum number of display heads", + "name": "maxheads", + "type": "long" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { @@ -97662,68 +97870,94 @@ "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, {}, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the name of the virtual machine", + "name": "name", "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": "State of the Service from LB rule", - "name": "servicestate", + "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": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" + }, + { + "description": "the video RAM size in MB", + "name": "videoram", "type": "long" }, { - "description": "Instance lease expiry date", - "name": "leaseexpirydate", - "type": "date" + "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 control state of the host for the virtual machine", + "name": "hostcontrolstate", + "type": "string" }, + {}, { - "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": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" + }, + { + "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 list of resource tags associated", "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -97732,23 +97966,18 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -97757,13 +97986,13 @@ "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" }, { @@ -97772,86 +98001,96 @@ "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" } ], "type": "set" }, { - "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", + "type": "string" }, { - "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": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", + "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 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": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "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", + "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": "the password (if exists) of the virtual machine", + "name": "password", + "type": "string" }, { - "description": "User VM type", - "name": "vmtype", - "type": "string" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "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 vGPU type used by the virtual machine", - "name": "vgpu", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" + "description": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", + "type": "string" + }, + { + "description": "the count of GPUs on the virtual machine", + "name": "gpucount", "type": "integer" }, { @@ -97860,115 +98099,165 @@ "type": "string" }, { - "description": "Instance lease duration in days", - "name": "leaseduration", - "type": "integer" + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", + "description": "OS type id of the vm", + "name": "ostypeid", + "type": "string" + }, + { + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", "type": "long" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "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", + "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", + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", + "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "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": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" }, { - "description": "the maximum Y resolution", - "name": "maxresolutiony", - "type": "long" + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "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 group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" + "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 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 virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, { "description": "the list of ingress rules associated with the security group", "name": "ingressrule", "response": [ - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, { "description": "the 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": "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 list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "tag key name", - "name": "key", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the 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 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" }, { @@ -97977,18 +98266,18 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the 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 project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -98004,26 +98293,6 @@ ], "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", @@ -98038,17 +98307,32 @@ "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 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 egress rules associated with the security group", "name": "egressrule", "response": [ { - "description": "the starting IP of the security group rule", - "name": "startport", + "description": "the code for the ICMP message response", + "name": "icmpcode", "type": "integer" }, { @@ -98057,8 +98341,18 @@ "type": "string" }, { - "description": "security group name", - "name": "securitygroupname", + "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" }, { @@ -98067,32 +98361,37 @@ "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 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 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": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -98101,18 +98400,8 @@ "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", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -98125,40 +98414,35 @@ "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" } ], "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": "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" } ], "type": "set" }, { - "description": "the domain ID of the security group", - "name": "domainid", + "description": "the account owning the security group", + "name": "account", "type": "string" }, { @@ -98167,17 +98451,37 @@ "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 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 name of the security group", + "name": "name", + "type": "string" }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -98186,23 +98490,23 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "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": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -98211,8 +98515,8 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -98221,209 +98525,287 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", - "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 project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name of the group", - "name": "project", - "type": "string" - }, - { - "description": "the ID of the security group", - "name": "id", - "type": "string" - }, - { - "description": "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 virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "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", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", "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 memory used by the VM in KiB", - "name": "memorykbs", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", + "type": "string" + }, + { + "description": "device ID of the root volume", + "name": "rootdeviceid", "type": "long" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", "type": "boolean" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", + "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 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 template for the virtual machine", + "name": "templatename", + "type": "string" + }, + { + "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 name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" + }, + { + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" + }, + { + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" + }, + { + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", + "type": "string" + }, + { + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, + { + "description": "the list of nics associated with vm", + "name": "nic", "response": [ { - "description": "the name of the affinity group", - "name": "name", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", + "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 ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", "type": "list" }, { - "description": "the account owning the affinity group", - "name": "account", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", + "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 traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", "type": "list" }, { - "description": "the ID of the affinity group", - "name": "id", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "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": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the maximum X resolution", + "name": "maxresolutionx", + "type": "long" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" }, { "description": "the ID of the backup offering of the virtual machine", @@ -98431,177 +98813,96 @@ "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 VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "the name of the vgpu profile to which service offering is linked", - "name": "vgpuprofilename", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" - }, - { - "description": "the maximum number of display heads", - "name": "maxheads", + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", "type": "long" }, { - "description": "the format of the template for the virtual machine", - "name": "templateformat", + "description": "CPU arch of the VM", + "name": "arch", "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" - }, - { - "description": "the ID of the host for the virtual machine", - "name": "hostid", - "type": "string" + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" }, { - "description": "ssh key-pairs", - "name": "keypairs", - "type": "string" + "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": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "the id of userdata used for the VM", + "name": "userdataid", "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": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, + {}, { - "description": "CPU arch of the VM", - "name": "arch", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" - } - ] - }, - { - "description": "Enables HA cluster-wide", - "isasync": true, - "name": "enableHAForCluster", - "params": [ - { - "description": "ID of the cluster", - "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", - "required": true, - "type": "uuid" - } - ], - "response": [ - { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - {}, - { - "description": "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.11" + ] }, { "description": "Add VMs to an ExternalManaged kubernetes cluster. Not applicable for CloudManaged kubernetes clusters.", "isasync": false, "name": "addVirtualMachinesToKubernetesCluster", "params": [ + { + "description": "the IDs of the VMs to add to the cluster", + "length": 255, + "name": "virtualmachineids", + "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,createVMFromBackup,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "required": true, + "type": "list" + }, { "description": "Is control node or not? Defaults to false.", "length": 255, @@ -98616,19 +98917,9 @@ "related": "createKubernetesCluster,startKubernetesCluster,scaleKubernetesCluster", "required": true, "type": "uuid" - }, - { - "description": "the IDs of the VMs to add to the cluster", - "length": 255, - "name": "virtualmachineids", - "related": "assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm", - "required": true, - "type": "list" } ], "response": [ - {}, - {}, { "description": "true if operation is executed successfully", "name": "success", @@ -98639,6 +98930,8 @@ "name": "jobstatus", "type": "integer" }, + {}, + {}, { "description": "any text associated with the success or failure", "name": "displaytext", @@ -98657,6 +98950,13 @@ "isasync": false, "name": "listTungstenFabricLogicalRouter", "params": [ + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, { "description": "the uuid of Tungsten-Fabric logical router", "length": 255, @@ -98672,13 +98972,6 @@ "required": false, "type": "uuid" }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, { "description": "", "length": 255, @@ -98687,54 +98980,54 @@ "type": "integer" }, { - "description": "the uuid of Tungsten-Fabric network", + "description": "List by keyword", "length": 255, - "name": "networkuuid", + "name": "keyword", "required": false, "type": "string" }, { - "description": "", + "description": "the uuid of Tungsten-Fabric network", "length": 255, - "name": "page", + "name": "networkuuid", "required": false, - "type": "integer" + "type": "string" } ], "related": "createTungstenFabricLogicalRouter,removeTungstenFabricNetworkGatewayFromLogicalRouter", "response": [ + {}, + {}, { - "description": "Tungsten-Fabric logical router name", - "name": "name", - "type": "string" + "description": "list Tungsten-Fabric policy network name", + "name": "network", + "type": "list" }, { "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 name", + "name": "name", + "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": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "Tungsten-Fabric logical router uuid", "name": "uuid", @@ -98747,27 +99040,34 @@ "isasync": false, "name": "listBackupOfferings", "params": [ + { + "description": "The backup offering ID", + "length": 255, + "name": "id", + "related": "listBackupOfferings,updateBackupOffering", + "required": false, + "type": "uuid" + }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "The backup offering ID", + "description": "List by keyword", "length": 255, - "name": "id", - "related": "listBackupOfferings,updateBackupOffering", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { "description": "The zone ID", @@ -98776,42 +99076,38 @@ "related": "listZones", "required": false, "type": "uuid" - }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" } ], "related": "updateBackupOffering", "response": [ { - "description": "whether offering allows user driven ad-hoc/scheduled backups", - "name": "allowuserdrivenbackups", - "type": "boolean" + "description": "zone ID", + "name": "zoneid", + "type": "string" }, - {}, { - "description": "zone name", - "name": "zonename", + "description": "name for the backup offering", + "name": "name", "type": "string" }, + { + "description": "whether offering allows user driven ad-hoc/scheduled backups", + "name": "allowuserdrivenbackups", + "type": "boolean" + }, { "description": "the date this backup offering was created", "name": "created", "type": "date" }, { - "description": "provider name", - "name": "provider", + "description": "zone name", + "name": "zonename", "type": "string" }, - {}, { - "description": "external ID on the provider side", - "name": "externalid", + "description": "provider name", + "name": "provider", "type": "string" }, { @@ -98819,10 +99115,12 @@ "name": "description", "type": "string" }, + {}, + {}, { - "description": "name for the backup offering", - "name": "name", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "ID of the backup offering", @@ -98830,14 +99128,14 @@ "type": "string" }, { - "description": "zone ID", - "name": "zoneid", + "description": "external ID on the provider side", + "name": "externalid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "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", @@ -98860,18 +99158,11 @@ "type": "string" }, { - "description": "device name of the GPU card", - "length": 255, - "name": "devicename", - "required": false, - "type": "string" - }, - { - "description": "vendor ID of the GPU card", + "description": "", "length": 255, - "name": "vendorid", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { "description": "", @@ -98888,6 +99179,13 @@ "required": false, "type": "uuid" }, + { + "description": "If true, only GPU cards which have a device will be listed. If false, all GPU cards will be listed.", + "length": 255, + "name": "activeonly", + "required": false, + "type": "boolean" + }, { "description": "vendor name of the GPU card", "length": 255, @@ -98896,69 +99194,69 @@ "type": "string" }, { - "description": "List by keyword", + "description": "vendor ID of the GPU card", "length": 255, - "name": "keyword", + "name": "vendorid", "required": false, "type": "string" }, { - "description": "If true, only GPU cards which have a device will be listed. If false, all GPU cards will be listed.", + "description": "List by keyword", "length": 255, - "name": "activeonly", + "name": "keyword", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "", + "description": "device name of the GPU card", "length": 255, - "name": "pagesize", + "name": "devicename", "required": false, - "type": "integer" + "type": "string" } ], "related": "", "response": [ { - "description": "the device ID of the GPU card", - "name": "deviceid", + "description": "the device name of the GPU card", + "name": "devicename", "type": "string" }, + {}, { "description": "the vendor name of the GPU card", "name": "vendorname", "type": "string" }, { - "description": "the display name of the GPU card", - "name": "name", + "description": "the ID of the GPU card", + "name": "id", "type": "string" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the display name of the GPU card", + "name": "name", + "type": "string" }, { "description": "the vendor ID of the GPU card", "name": "vendorid", "type": "string" }, - {}, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the device name of the GPU card", - "name": "devicename", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the ID of the GPU card", - "name": "id", + "description": "the device ID of the GPU card", + "name": "deviceid", "type": "string" } ], @@ -98969,13 +99267,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, @@ -98984,26 +99275,17 @@ "type": "string" }, { - "description": "UUID of Guest OS type. Either the UUID or Display Name must be passed", + "description": "Hypervisor version to create the mapping. Use 'default' for default versions. Please check hypervisor capabilities for correct version", "length": 255, - "name": "ostypeid", - "related": "addGuestOs", - "required": false, - "type": "uuid" + "name": "hypervisorversion", + "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.)", + "description": "Display Name of Guest OS standard type. Either Display Name or UUID must be passed", "length": 255, - "name": "osmappingcheckenabled", + "name": "osdisplayname", "required": false, - "since": "4.19.0", - "type": "boolean" - }, - { - "description": "Hypervisor version to create the mapping. Use 'default' for default versions. Please check hypervisor capabilities for correct version", - "length": 255, - "name": "hypervisorversion", - "required": true, "type": "string" }, { @@ -99020,10 +99302,31 @@ "required": false, "since": "4.19.0", "type": "boolean" + }, + { + "description": "UUID of Guest OS type. Either the UUID or Display Name must be passed", + "length": 255, + "name": "ostypeid", + "related": "addGuestOs", + "required": false, + "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.)", + "length": 255, + "name": "osmappingcheckenabled", + "required": false, + "since": "4.19.0", + "type": "boolean" } ], "related": "updateGuestOsMapping", "response": [ + { + "description": "the ID of the Guest OS type", + "name": "ostypeid", + "type": "string" + }, {}, { "description": "the current status of the latest async job acting on this object", @@ -99031,45 +99334,40 @@ "type": "integer" }, { - "description": "is the mapping user defined", - "name": "isuserdefined", - "type": "string" - }, - { - "description": "the ID of the Guest OS type", - "name": "ostypeid", + "description": "version of the hypervisor for mapping", + "name": "hypervisorversion", "type": "string" }, - {}, { "description": "the ID of the Guest OS mapping", "name": "id", "type": "string" }, - { - "description": "version of the hypervisor for mapping", - "name": "hypervisorversion", - "type": "string" - }, { "description": "hypervisor specific name for the Guest OS", "name": "osnameforhypervisor", "type": "string" }, + {}, { "description": "the hypervisor", "name": "hypervisor", "type": "string" }, { - "description": "standard display name for the Guest OS", - "name": "osdisplayname", + "description": "is the mapping user defined", + "name": "isuserdefined", "type": "string" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" + }, + { + "description": "standard display name for the Guest OS", + "name": "osdisplayname", + "type": "string" } ], "since": "4.4.0" @@ -99080,51 +99378,61 @@ "name": "listVnfTemplates", "params": [ { - "description": "the hypervisor for which to restrict the search", + "description": "flag to display the resource image for the templates", "length": 255, - "name": "hypervisor", + "name": "showicon", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "comma separated list of template details requested, value can be a list of [ all, min]", + "description": "the CPU arch of the template. Valid options are: x86_64, aarch64", "length": 255, - "name": "details", + "name": "arch", "required": false, - "since": "4.15", - "type": "list" + "since": "4.20", + "type": "string" }, { - "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,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": "list templates that can be used to deploy CKS clusters", + "description": "comma separated list of template details requested, value can be a list of [ all, min]", "length": 255, - "name": "forcks", + "name": "details", "required": false, - "since": "4.21.0", - "type": "boolean" + "since": "4.15", + "type": "list" }, { - "description": "List resources by tags (key/value pairs)", + "description": "the ID of the OS category for the template", "length": 255, - "name": "tags", + "name": "oscategoryid", + "related": "listOsCategories", "required": false, - "type": "map" + "since": "4.21.0", + "type": "uuid" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, + { + "description": "the IDs of the templates, mutually exclusive with id", + "length": 255, + "name": "ids", + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "required": false, + "since": "4.9", + "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.", "length": 255, @@ -99133,113 +99441,95 @@ "type": "boolean" }, { - "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 templates by zoneId", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains", + "name": "zoneid", + "related": "listZones", "required": false, "type": "uuid" }, { - "description": "the template name", + "description": "list templates that can be used to deploy CKS clusters", "length": 255, - "name": "name", + "name": "forcks", "required": false, - "type": "string" + "since": "4.21.0", + "type": "boolean" }, { - "description": "List by keyword", + "description": "the type of the template", "length": 255, - "name": "keyword", + "name": "templatetype", "required": false, + "since": "4.19.0", "type": "string" }, { - "description": "flag to list VNF templates or not; true if need to list VNF templates, false otherwise.", + "description": "If set to true, list only unique templates across zones", "length": 255, - "name": "isvnf", + "name": "showunique", "required": false, - "since": "4.19.0", + "since": "4.13.2", "type": "boolean" }, { - "description": "flag to display the resource image for the templates", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "showicon", + "name": "account", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "list datadisk templates by parent template id", "length": 255, - "name": "isrecursive", + "name": "parenttemplateid", + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", "required": false, - "type": "boolean" + "since": "4.4", + "type": "uuid" }, { - "description": "the IDs of the templates, mutually exclusive with id", + "description": "show removed templates as well", "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", + "name": "showremoved", "required": false, - "since": "4.9", - "type": "list" + "type": "boolean" }, { - "description": "the CPU arch of the template. Valid options are: x86_64, aarch64", + "description": "the hypervisor for which to restrict the search", "length": 255, - "name": "arch", + "name": "hypervisor", "required": false, - "since": "4.20", "type": "string" }, { - "description": "ID of the extension for the template", - "length": 255, - "name": "extensionid", - "related": "listExtensions,deleteExtension,updateExtension,unregisterExtension", - "required": false, - "since": "4.21.0", - "type": "uuid" - }, - { - "description": "show removed templates as well", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "showremoved", + "name": "isrecursive", "required": false, "type": "boolean" }, { - "description": "the ID of the OS category for the template", - "length": 255, - "name": "oscategoryid", - "related": "listOsCategories", - "required": false, - "since": "4.21.0", - "type": "uuid" - }, - { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "projectid", - "related": "createProject", + "name": "tags", "required": false, - "type": "uuid" + "type": "map" }, { - "description": "If set to true, list only unique templates across zones", + "description": "", "length": 255, - "name": "showunique", + "name": "page", "required": false, - "since": "4.13.2", - "type": "boolean" + "type": "integer" }, { "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,11 +99539,20 @@ "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "account", + "name": "domainid", + "related": "createDomain,listDomains,listDomains", "required": false, - "type": "string" + "type": "uuid" + }, + { + "description": "the template ID", + "length": 255, + "name": "id", + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "required": false, + "type": "uuid" }, { "description": "list templates that are ready to be deployed", @@ -99264,67 +99563,55 @@ "type": "boolean" }, { - "description": "the type of the template", + "description": "ID of the extension for the template", "length": 255, - "name": "templatetype", + "name": "extensionid", + "related": "listExtensions,deleteExtension,updateExtension,unregisterExtension", "required": false, - "since": "4.19.0", - "type": "string" + "since": "4.21.0", + "type": "uuid" }, { - "description": "the template ID", + "description": "the template name", "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", + "name": "name", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list templates by zoneId", + "description": "List by keyword", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" } ], - "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", "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", - "type": "boolean" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "checksum of the template", + "name": "checksum", + "type": "string" }, - {}, { - "description": "the template name", - "name": "name", - "type": "string" + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" }, { - "description": "CPU Arch of the template", - "name": "arch", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the name of the secondary storage host for the template", - "name": "hostname", + "description": "the type of the template", + "name": "templatetype", "type": "string" }, { - "description": "the URL which the template/iso is registered from", - "name": "url", - "type": "string" + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", + "type": "boolean" }, { "description": "If true it indicates that the template can be used for CKS cluster deployments", @@ -99332,123 +99619,133 @@ "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 tag of this template", - "name": "templatetag", + "description": "the name of the domain to which the template belongs", + "name": "domain", "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", + "type": "string" + }, + { + "description": "the date this template was removed", + "name": "removed", + "type": "date" }, { - "description": "the name of the OS type for this template.", - "name": "ostypename", - "type": "string" + "description": "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", + "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", + "name": "deployasis", + "type": "boolean" + }, + {}, + { + "description": "the ID of the domain to which the template belongs", + "name": "domainid", "type": "string" }, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "name": "isdynamicallyscalable", + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", "type": "boolean" }, { - "description": "the date this template was created", - "name": "created", - "type": "date" + "description": "the format of the template.", + "name": "format", + "type": "imageformat" }, { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" + "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": "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", + "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", + "description": "the name of userdata linked to this template", + "name": "userdataname", "type": "string" }, { - "description": "The ID of extension linked to this template", - "name": "extensionid", + "description": "the template name", + "name": "name", "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 template ID", - "name": "id", - "type": "string" + "description": "the physical size of the template", + "name": "physicalsize", + "type": "long" }, { - "description": "path of the Domain the template belongs to", - "name": "domainpath", - "type": "string" + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" }, { - "description": "the status of the template", - "name": "status", + "description": "the tag of this template", + "name": "templatetag", "type": "string" }, { - "description": "the template display text", - "name": "displaytext", - "type": "string" + "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", + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", "type": "string" }, { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "path of the Domain the template belongs to", + "name": "domainpath", + "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": "true if this template is a public template, false otherwise", - "name": "ispublic", - "type": "boolean" + "description": "the template ID", + "name": "id", + "type": "string" }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "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 project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -99456,14 +99753,19 @@ "name": "domainpath", "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", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -99472,23 +99774,18 @@ "type": "string" }, { - "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": "resource type", - "name": "resourcetype", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -99500,84 +99797,86 @@ "type": "set" }, { - "description": "the name of userdata linked to this template", - "name": "userdataname", + "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 project name of the template", - "name": "project", + "description": "the ID of the secondary storage host for the template", + "name": "hostid", "type": "string" }, { - "description": "the project id of the template", - "name": "projectid", + "description": "the id of userdata linked to this template", + "name": "userdataid", "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": "the account id to which the template belongs", - "name": "accountid", + "description": "the URL which the template/iso is registered from", + "name": "url", "type": "string" }, { - "description": "the id of userdata linked to this template", - "name": "userdataid", + "description": "The ID of extension linked to this template", + "name": "extensionid", "type": "string" }, { - "description": "the name of the domain to which the template belongs", - "name": "domain", - "type": "string" + "description": "the size of the template", + "name": "size", + "type": "long" }, + {}, { "description": "the processor bit size", "name": "bits", "type": "int" }, { - "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", - "name": "userdataparams", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the ID of the zone for this template", - "name": "zoneid", + "description": "the date this template was created", + "name": "created", + "type": "date" + }, + { + "description": "the status of the template", + "name": "status", "type": "string" }, { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "name": "isdynamicallyscalable", "type": "boolean" }, { - "description": "the type of the template", - "name": "templatetype", + "description": "the template display text", + "name": "displaytext", "type": "string" }, { - "description": "the size of the template", - "name": "size", - "type": "long" + "description": "The name of extension linked to this template", + "name": "extensionname", + "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 format of the template.", - "name": "format", - "type": "imageformat" + "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", @@ -99585,64 +99884,63 @@ "type": "string" }, { - "description": "the account name to which the template belongs", - "name": "account", + "description": "CPU Arch of the template", + "name": "arch", "type": "string" }, { - "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": "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", + "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": "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 account id to which the template belongs", + "name": "accountid", + "type": "string" }, { - "description": "checksum of the template", - "name": "checksum", - "type": "string" + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, - {}, { "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", "name": "directdownload", "type": "boolean" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the ID of the OS type for this template.", + "name": "ostypeid", + "type": "string" }, { - "description": "The name of extension linked to this template", - "name": "extensionname", + "description": "the project name of the template", + "name": "project", "type": "string" }, { - "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", - "name": "deployasis", + "description": "the name of the secondary storage host for the template", + "name": "hostname", + "type": "string" + }, + { + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", "type": "boolean" } ], @@ -99654,35 +99952,51 @@ "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": "Boot into hardware setup or not (ignored if startVm = false, only valid for vmware)", "length": 255, - "name": "affinitygroupids", - "related": "", + "name": "bootintosetup", "required": false, - "type": "list" + "since": "4.15.0.0", + "type": "boolean" }, { - "description": "the arbitrary size for the DATADISK volume. Mutually exclusive with diskOfferingId", + "description": "The password of the virtual machine. If null, a random password will be generated for the VM.", "length": 255, - "name": "size", + "name": "password", "required": false, - "type": "long" + "since": "4.19.0.0", + "type": "string" }, { - "description": "Boot into hardware setup or not (ignored if startVm = false, only valid for vmware)", + "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": "bootintosetup", + "name": "vnfconfiguremanagement", "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": "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": "nicnetworklist", + "name": "boottype", "required": false, - "since": "4.15", - "type": "map" + "since": "4.14.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", + "length": 255, + "name": "rootdisksize", + "required": false, + "since": "4.4", + "type": "long" + }, + { + "description": "Lease expiry action, valid values are STOP and DESTROY", + "length": 255, + "name": "leaseexpiryaction", + "required": false, + "since": "4.21.0", + "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", @@ -99692,12 +100006,11 @@ "type": "string" }, { - "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 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": "datadiskofferinglist", + "name": "hypervisor", "required": false, - "since": "4.11", - "type": "map" + "type": "string" }, { "description": "The number of queues for multiqueue NICs.", @@ -99708,21 +100021,19 @@ "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": "the ID of the template for the virtual machine", "length": 255, - "name": "overridediskofferingid", - "related": "", + "name": "templateid", + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", "required": false, - "since": "4.17", "type": "uuid" }, { - "description": "the ID of the service offering for the virtual machine", + "description": "the CIDR list to forward traffic from to the VNF management interface. Multiple entries must be separated by a single comma character (,). The default value is 0.0.0.0/0.", "length": 255, - "name": "serviceofferingid", - "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", - "required": true, - "type": "uuid" + "name": "vnfcidrlist", + "required": false, + "type": "list" }, { "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", @@ -99733,96 +100044,81 @@ "type": "map" }, { - "description": "comma separated list of affinity groups names that are going to be applied to the virtual machine.Mutually exclusive with affinitygroupids parameter", + "description": "used to specify the vApp properties.", "length": 255, - "name": "affinitygroupnames", - "related": "", + "name": "properties", "required": false, - "type": "list" + "since": "4.15", + "type": "map" }, { - "description": "used to specify the custom parameters. 'extraconfig' is not allowed to be passed in details", + "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": "details", + "name": "domainid", + "related": "createDomain,listDomains,listDomains", "required": false, - "since": "4.3", - "type": "map" + "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": "the arbitrary size for the DATADISK volume. Mutually exclusive with diskOfferingId", "length": 255, - "name": "bootmode", + "name": "size", "required": false, - "since": "4.14.0.0", - "type": "string" + "type": "long" }, { - "description": "the ID of the template for the virtual machine", + "description": "", "length": 255, - "name": "templateid", - "related": "prepareTemplate,listIsos,updateIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "name": "snapshotid", + "related": "createSnapshotFromVMSnapshot,copySnapshot,archiveSnapshot,listSnapshots,listSnapshots", "required": false, + "since": "4.21", "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": "availability zone for the virtual machine", "length": 255, - "name": "iptonetworklist", - "required": false, - "type": "map" + "name": "zoneid", + "related": "listZones", + "required": true, + "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,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", "required": false, "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, - "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", + "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": "Deployment planner to use for vm allocation. Available to ROOT admin only", + "description": "Controls specific policies on IO", "length": 255, - "name": "deploymentplanner", + "name": "iodriverpolicy", "required": false, - "since": "4.4", "type": "string" }, { - "description": "an optional account for the virtual machine. Must be used with domainId.", + "description": "Details in key/value pairs using format externaldetails[i].keyname=keyvalue. Example: externaldetails[0].server.type=typevalue", "length": 255, - "name": "account", + "name": "externaldetails", "required": false, - "type": "string" + "since": "4.21.0", + "type": "map" }, { "description": "the ip address for default vm's network", @@ -99832,95 +100128,106 @@ "type": "string" }, { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins 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": "customid", + "name": "affinitygroupnames", + "related": "", "required": false, - "type": "string" + "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": "names of the ssh key pairs used to login to the virtual machine", + "length": 255, + "name": "keypairs", "required": false, - "type": "string" + "since": "4.17", + "type": "list" }, { - "description": "Deploy vm for the project", + "description": "", "length": 255, - "name": "projectid", - "related": "createProject", + "name": "volumeid", + "related": "importVolume,createVolume,updateVolume,listVolumes,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", "required": false, + "since": "4.21", "type": "uuid" }, { - "description": "Lease expiry action, valid values are STOP and DESTROY", + "description": "the mac address for default vm's network", "length": 255, - "name": "leaseexpiryaction", + "name": "macaddress", "required": false, - "since": "4.21.0", "type": "string" }, { - "description": "Details in key/value pairs using format externaldetails[i].keyname=keyvalue. Example: externaldetails[0].server.type=typevalue", + "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": "externaldetails", + "name": "overridediskofferingid", + "related": "", "required": false, - "since": "4.21.0", - "type": "map" + "since": "4.17", + "type": "uuid" }, { - "description": "an optional user generated name for the virtual machine", + "description": "the ID of the service offering for the virtual machine", "length": 255, - "name": "displayname", - "required": false, - "type": "string" + "name": "serviceofferingid", + "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", + "required": true, + "type": "uuid" }, { - "description": "name of the ssh key pair used to login to the virtual machine", + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "keypair", + "name": "customid", "required": false, "type": "string" }, { - "description": "the ID of the disk offering for the virtual machine. If the template is of ISO format, the diskOfferingId is for the root disk volume. Otherwise this parameter is used to indicate the offering for the data disk volume. If the templateId parameter passed is from a Template object, the diskOfferingId refers to a DATA Disk Volume created. If the templateId parameter passed is from an ISO object, the diskOfferingId refers to a ROOT Disk Volume created.", + "description": "comma separated list of affinity groups id that are going to be applied to the virtual machine. Mutually exclusive with affinitygroupnames parameter", "length": 255, - "name": "diskofferingid", + "name": "affinitygroupids", "related": "", "required": false, - "type": "uuid" + "type": "list" }, { - "description": "true if start vm after creating; defaulted to true if not specified", + "description": "an optional user generated name for the virtual machine", "length": 255, - "name": "startvm", + "name": "displayname", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "names of the ssh key pairs used to login to the virtual machine", + "description": "Number of days instance is leased for.", "length": 255, - "name": "keypairs", + "name": "leaseduration", "required": false, - "since": "4.17", - "type": "list" + "since": "4.21.0", + "type": "integer" }, { - "description": "Enable packed virtqueues or not.", + "description": "DHCP options which are passed to the VM on start up Example: dhcpoptionsnetworklist[0].dhcp:114=url&dhcpoptionsetworklist[0].networkid=networkid&dhcpoptionsetworklist[0].dhcp:66=www.test.com", "length": 255, - "name": "nicpackedvirtqueuesenabled", + "name": "dhcpoptionsnetworklist", "required": false, - "since": "4.18", - "type": "boolean" + "type": "map" }, { - "description": "used to specify the vApp properties.", + "description": "an optional group for the virtual machine", "length": 255, - "name": "properties", + "name": "group", "required": false, - "since": "4.15", - "type": "map" + "type": "string" + }, + { + "description": "the ID of the Userdata", + "length": 255, + "name": "userdataid", + "related": "listCniConfiguration", + "required": false, + "since": "4.18", + "type": "uuid" }, { "description": "if true the image tags (if any) will be copied to the VM, default value is false", @@ -99931,103 +100238,112 @@ "type": "boolean" }, { - "description": "", + "description": "Deploy vm for the project", "length": 255, - "name": "volumeid", - "related": "createVolume,updateVolume,listVolumes,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", + "name": "projectid", + "related": "createProject", "required": false, - "since": "4.21", "type": "uuid" }, { - "description": "Controls specific policies on IO", + "description": "used to specify the custom parameters. 'extraconfig' is not allowed to be passed in details", "length": 255, - "name": "iodriverpolicy", + "name": "details", + "required": false, + "since": "4.3", + "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": "destination Host ID to deploy the VM to - parameter available for root admin only", + "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": "hostid", - "related": "declareHostAsDegraded,reconnectHost", + "name": "nicnetworklist", "required": false, - "type": "uuid" + "since": "4.15", + "type": "map" }, { - "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": "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": "hypervisor", + "name": "bootmode", "required": false, + "since": "4.14.0.0", "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 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": "networkids", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", + "name": "securitygroupids", + "related": "updateSecurityGroup", "required": false, "type": "list" }, { - "description": "host name for the virtual machine", + "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": "name", + "name": "iptonetworklist", "required": false, - "type": "string" + "type": "map" }, { - "description": "Number of days instance is leased for.", + "description": "true if virtual machine needs to be dynamically scalable", "length": 255, - "name": "leaseduration", + "name": "dynamicscalingenabled", "required": false, - "since": "4.21.0", - "type": "integer" + "since": "4.16", + "type": "boolean" }, { - "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 packed virtqueues or not.", "length": 255, - "name": "iothreadsenabled", + "name": "nicpackedvirtqueuesenabled", "required": false, + "since": "4.18", "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": "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": "domainid", - "related": "createDomain,listDomains,listDomains", + "name": "iothreadsenabled", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "the mac address for default vm's network", + "description": "name of the ssh key pair used to login to the virtual machine", "length": 255, - "name": "macaddress", + "name": "keypair", "required": false, "type": "string" }, { - "description": "True by default, security group or network rules (source nat and firewall rules) will be configured for VNF management interfaces. False otherwise. Network rules are configured if management network is an isolated network or shared network with security groups.", + "description": "the ipv6 address for default vm's network", "length": 255, - "name": "vnfconfiguremanagement", + "name": "ip6address", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "used to specify the parameters values for the variables in userdata.", + "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": "userdatadetails", + "name": "datadiskofferinglist", "required": false, - "since": "4.18", + "since": "4.11", "type": "map" }, { - "description": "availability zone for the virtual machine", + "description": "Deployment planner to use for vm allocation. Available to ROOT admin only", "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, - "type": "uuid" + "name": "deploymentplanner", + "required": false, + "since": "4.4", + "type": "string" }, { "description": "an optional field, whether to the display the vm to the end user or not.", @@ -100038,376 +100354,247 @@ "type": "boolean" }, { - "description": "", + "description": "destination Host ID to deploy the VM to - parameter available for root admin only", "length": 255, - "name": "snapshotid", - "related": "createSnapshotFromVMSnapshot,copySnapshot,archiveSnapshot,listSnapshots,listSnapshots", + "name": "hostid", + "related": "declareHostAsDegraded,reconnectHost", "required": false, - "since": "4.21", "type": "uuid" }, { - "description": "The password of the virtual machine. If null, a random password will be generated for the VM.", - "length": 255, - "name": "password", - "required": false, - "since": "4.19.0.0", - "type": "string" - }, - { - "description": "the ID of the Userdata", + "description": "used to specify the parameters values for the variables in userdata.", "length": 255, - "name": "userdataid", - "related": "listCniConfiguration", + "name": "userdatadetails", "required": false, "since": "4.18", - "type": "uuid" + "type": "map" }, { - "description": "the ipv6 address for default vm's network", + "description": "host name for the virtual machine", "length": 255, - "name": "ip6address", + "name": "name", "required": false, "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": "an optional account for the virtual machine. Must be used with domainId.", "length": 255, - "name": "rootdisksize", + "name": "account", "required": false, - "since": "4.4", - "type": "long" + "type": "string" }, { - "description": "the CIDR list to forward traffic from to the VNF management interface. Multiple entries must be separated by a single comma character (,). The default value is 0.0.0.0/0.", + "description": "comma separated list of security groups names that going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupids parameter", "length": 255, - "name": "vnfcidrlist", + "name": "securitygroupnames", + "related": "updateSecurityGroup", "required": false, "type": "list" }, { - "description": "true if virtual machine needs to be dynamically scalable", + "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": "dynamicscalingenabled", + "name": "diskofferingid", + "related": "", "required": false, - "since": "4.16", + "type": "uuid" + } + ], + "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,createVMFromBackup,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "response": [ + { + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", + "type": "string" + }, + { + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "Guest VM Boot option either custom[UEFI] or default boot [BIOS]. Not applicable with VMware if the template is marked as deploy-as-is, as we honour what is defined in the template.", - "length": 255, - "name": "boottype", - "required": false, - "since": "4.14.0.0", + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, + { + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" + }, + { + "description": "ssh key-pairs", + "name": "keypairs", "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 hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", "response": [ { - "description": "tag value", - "name": "value", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", - "type": "string" + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" }, { - "description": "the ID of the domain associated with the tag", + "description": "the domain ID of the affinity group", "name": "domainid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the type of the affinity group", + "name": "type", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "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": "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", - "type": "boolean" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" - }, - { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", - "type": "string" - }, - { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", - "type": "string" - }, - { - "description": "the ID of the virtual machine", - "name": "id", - "type": "string" - }, - { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", - "type": "string" - }, - { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" - }, - { - "description": "the 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", - "type": "string" - }, { "description": "path of the domain in which the virtual machine exists", "name": "domainpath", "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "Instance lease expiry date", - "name": "leaseexpirydate", - "type": "date" - }, - { - "description": "the maximum Y resolution", - "name": "maxresolutiony", - "type": "long" - }, - { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", - "type": "string" - }, - { - "description": "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 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", + "description": "device ID of the root volume", + "name": "rootdeviceid", "type": "long" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", - "type": "string" - }, - { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "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": "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": "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 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": "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": "Guest vm Boot Mode", - "name": "bootmode", - "type": "string" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { "description": "the id of userdata used for the VM", @@ -100415,68 +100602,38 @@ "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", + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "User VM type", - "name": "vmtype", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", - "type": "string" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "the maximum number of display heads", + "name": "maxheads", "type": "long" }, { - "description": "the 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 internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" - }, - { - "description": "Instance lease duration in days", - "name": "leaseduration", - "type": "integer" - }, - { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { @@ -100484,58 +100641,170 @@ "name": "securitygroup", "response": [ { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "the name of the security group", + "name": "name", + "type": "string" + }, + { + "description": "the project name of the group", + "name": "project", + "type": "string" + }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", "response": [ { - "description": "security group name", - "name": "securitygroupname", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" + "description": "tag value", + "name": "value", + "type": "string" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the 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": "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 ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "path of the Domain 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 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": "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 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": "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": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, { "description": "the project id the tag belongs to", "name": "projectid", @@ -100547,8 +100816,8 @@ "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -100557,8 +100826,13 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -100567,8 +100841,8 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -100577,49 +100851,34 @@ "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", + "description": "the account associated with the tag", + "name": "account", "type": "string" } ], "type": "set" + }, + { + "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 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 egress rules associated with the security group", - "name": "egressrule", + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", "response": [ { - "description": "account owning the security group rule", - "name": "account", - "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", @@ -100632,27 +100891,22 @@ "type": "string" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" + "description": "account owning the security group rule", + "name": "account", + "type": "string" }, { "description": "the list of resource tags associated with the rule", "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" }, { - "description": "tag value", - "name": "value", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -100660,11 +100914,6 @@ "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", @@ -100676,29 +100925,34 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "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": "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": "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" } ], "type": "set" @@ -100709,167 +100963,110 @@ "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", + "description": "the type of the ICMP message response", + "name": "icmptype", "type": "integer" - } - ], - "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": "path of the Domain the security group belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "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", + "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 code for the ICMP message response", + "name": "icmpcode", + "type": "integer" } ], "type": "set" - }, - { - "description": "the name of the security group", - "name": "name", - "type": "string" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" - }, - { - "description": "the account owning the security group", - "name": "account", - "type": "string" - }, - { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" } ], "type": "set" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + { + "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": "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": " 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": "the number of vCPUs this virtual machine is using", "name": "cpunumber", "type": "integer" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "the user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": "the 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 virtual machine", + "name": "account", + "type": "string" + }, + { + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" }, { "description": "CPU arch of the VM", @@ -100877,87 +101074,82 @@ "type": "string" }, { - "description": "the ID of the gpu card to which service offering is linked", - "name": "gpucardid", - "type": "string" + "description": "the count of GPUs on the virtual machine", + "name": "gpucount", + "type": "integer" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "Instance lease duration in days", + "name": "leaseduration", + "type": "integer" + }, + { + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, { "description": "the list of nics associated with vm", "name": "nic", "response": [ { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" + "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 IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, - { - "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", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the 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 vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "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", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { @@ -100966,48 +101158,38 @@ "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", + "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": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "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 broadcast uri of the nic", - "name": "broadcasturi", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "the gateway of the nic", + "name": "gateway", "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" }, { @@ -101016,189 +101198,239 @@ "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": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "description": "the ID of the affinity group", - "name": "id", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", - "type": "list" - }, - { - "description": "the description of the affinity group", - "name": "description", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", - "type": "string" + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "the netmask of the nic", + "name": "netmask", "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 broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" } ], "type": "set" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "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 gpu card to which service offering is linked", - "name": "gpucardname", + "description": "the maximum Y resolution", + "name": "maxresolutiony", + "type": "long" + }, + {}, + { + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", + "description": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" + }, + { + "description": "the state of the virtual machine", + "name": "state", + "type": "string" + }, + { + "description": "the video RAM size in MB", + "name": "videoram", "type": "long" }, { - "description": "the count of GPUs on the virtual machine", - "name": "gpucount", - "type": "integer" + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "the password (if exists) of the virtual machine", + "name": "password", "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 target memory in VM (KiB)", - "name": "memorytargetkbs", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" + }, + { + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", + "type": "string" + }, + { + "description": "User VM type", + "name": "vmtype", + "type": "string" + }, + { + "description": "the project name of the vm", + "name": "project", + "type": "string" + }, + { + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", "type": "long" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "type": "string" + }, + { + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", "type": "long" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "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 incoming network traffic on the VM in KiB", - "name": "networkkbsread", + "description": "the maximum X resolution", + "name": "maxresolutionx", "type": "long" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "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": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" + }, + { + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "Base64 string containing the user data", + "name": "userdata", + "type": "string" + }, + { + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", + "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 speed of each vCPU", "name": "cpuspeed", "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 action", + "name": "leaseexpiryaction", + "type": "string" + }, + { + "description": "the group name of the virtual machine", + "name": "group", + "type": "string" + }, + { + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", + "type": "string" }, { "description": "Os type ID of the virtual machine", @@ -101206,19 +101438,29 @@ "type": "string" }, { - "description": "the name of the vgpu profile to which service offering is linked", - "name": "vgpuprofilename", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "the VM's primary IP address", + "name": "ipaddress", "type": "string" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" + }, + { + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { "description": "the project id of the vm", @@ -101226,23 +101468,63 @@ "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "the project name of the vm", - "name": "project", + "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", + "description": "the pool type of the virtual machine", + "name": "pooltype", + "type": "string" + }, + { + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" + }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "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", + "name": "publicip", + "type": "string" + }, + { + "description": "the name of userdata used for the VM", + "name": "userdataname", + "type": "string" + }, + { + "description": "the format of the template for the virtual machine", + "name": "templateformat", + "type": "string" + }, + { + "description": "the name of the virtual machine", + "name": "name", + "type": "string" + }, + { + "description": "the user's name who deployed the virtual machine", + "name": "username", + "type": "string" + }, + { + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { @@ -101250,15 +101532,31 @@ "name": "isodisplaytext", "type": "string" }, + {}, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" + "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", + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "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" } ], "since": "4.19.0" @@ -101268,6 +101566,36 @@ "isasync": false, "name": "updateNetworkOffering", "params": [ + { + "description": "the id of the network offering", + "length": 255, + "name": "id", + "related": "createNetworkOffering,updateNetworkOffering,listNetworkOfferings", + "required": false, + "type": "uuid" + }, + { + "description": "the display text of the network offering", + "length": 255, + "name": "displaytext", + "required": false, + "type": "string" + }, + { + "description": "the ID of the containing zone(s) as comma separated string, all for all zones offerings", + "length": 4096, + "name": "zoneid", + "required": false, + "since": "4.13", + "type": "string" + }, + { + "description": "if true keepalive will be turned on in the loadbalancer. At the time of writing this has only an effect on haproxy; the mode http and httpclose options are unset in the haproxy conf file.", + "length": 255, + "name": "keepaliveenabled", + "required": false, + "type": "boolean" + }, { "description": "the name of the network offering", "length": 255, @@ -101282,13 +101610,6 @@ "required": false, "type": "string" }, - { - "description": "sort key of the network offering, integer", - "length": 255, - "name": "sortkey", - "required": false, - "type": "integer" - }, { "description": "maximum number of concurrent connections supported by the network offering", "length": 255, @@ -101303,28 +101624,6 @@ "required": false, "type": "string" }, - { - "description": "the ID of the containing zone(s) as comma separated string, all for all zones offerings", - "length": 4096, - "name": "zoneid", - "required": false, - "since": "4.13", - "type": "string" - }, - { - "description": "the 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" - }, - { - "description": "if true keepalive will be turned on in the loadbalancer. At the time of writing this has only an effect on haproxy; the mode http and httpclose options are unset in the haproxy conf file.", - "length": 255, - "name": "keepaliveenabled", - "required": false, - "type": "boolean" - }, { "description": "update state for the network offering", "length": 255, @@ -101333,62 +101632,114 @@ "type": "string" }, { - "description": "the display text of the network offering", + "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": "displaytext", + "name": "availability", "required": false, "type": "string" }, { - "description": "the id of the network offering", + "description": "sort key of the network offering, integer", "length": 255, - "name": "id", - "related": "createNetworkOffering,updateNetworkOffering,listNetworkOfferings", + "name": "sortkey", "required": false, - "type": "uuid" + "type": "integer" } ], "related": "createNetworkOffering,listNetworkOfferings", "response": [ + { + "description": "the date this network offering was created", + "name": "created", + "type": "date" + }, + { + "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": "supportspublicaccess", + "type": "boolean" + }, { "description": "true if network offering supports choosing AS numbers", "name": "specifyasnumber", "type": "boolean" }, { - "description": "true if network offering can be used by Tungsten-Fabric networks only", - "name": "fortungsten", + "description": "true if network offering supports specifying ip ranges, false otherwise", + "name": "specifyipranges", "type": "boolean" }, { - "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domain", + "description": "guest type of the network offering, can be Shared or Isolated", + "name": "guestiptype", "type": "string" }, + {}, { - "description": "state of the network offering. Can be Disabled/Enabled/Inactive", - "name": "state", + "description": "the name of the network offering", + "name": "name", "type": "string" }, { - "description": "true if network offering supports persistent networks, false otherwise", - "name": "ispersistent", + "description": "true if network offering is ip conserve mode enabled", + "name": "conservemode", "type": "boolean" }, { - "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 the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the id of the network offering", + "name": "id", + "type": "string" + }, + { + "description": "an alternate display text of the network offering.", + "name": "displaytext", + "type": "string" + }, + { + "description": "state of the network offering. Can be Disabled/Enabled/Inactive", + "name": "state", + "type": "string" + }, + { + "description": "data transfer rate in megabits per second allowed.", + "name": "networkrate", + "type": "integer" }, { "description": "the list of supported services", "name": "service", "response": [ + { + "description": "the list of capabilities", + "name": "capability", + "response": [ + { + "description": "the capability name", + "name": "name", + "type": "string" + }, + { + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" + }, + { + "description": "the capability value", + "name": "value", + "type": "string" + } + ], + "type": "list" + }, { "description": "the service name", "name": "name", @@ -101399,28 +101750,18 @@ "name": "provider", "response": [ { - "description": "services for this provider", - "name": "servicelist", - "type": "list" - }, - { - "description": "state of the network provider", - "name": "state", + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", "type": "string" }, { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" - }, - { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "uuid of the network provider", + "name": "id", "type": "string" }, { - "description": "uuid of the network provider", - "name": "id", + "description": "state of the network provider", + "name": "state", "type": "string" }, { @@ -101429,31 +101770,19 @@ "type": "string" }, { - "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", + "type": "boolean" }, { - "description": "the capability value", - "name": "value", - "type": "string" + "description": "services for this provider", + "name": "servicelist", + "type": "list" }, { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" } ], "type": "list" @@ -101462,13 +101791,13 @@ "type": "list" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if network offering supports persistent networks, false otherwise", + "name": "ispersistent", + "type": "boolean" }, { - "description": "the name of the network offering", - "name": "name", + "description": "the routing mode for the network offering, supported types are Static or Dynamic.", + "name": "routingmode", "type": "string" }, { @@ -101477,19 +101806,13 @@ "type": "boolean" }, { - "description": "true if guest network default egress policy is allow; false if default egress policy is deny", - "name": "egressdefaultpolicy", - "type": "boolean" - }, - {}, - { - "description": "maximum number of concurrents connections to be handled by lb", - "name": "maxconnections", - "type": "integer" + "description": "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", + "description": "the ID of the service offering used by virtual router provider", + "name": "serviceofferingid", "type": "string" }, { @@ -101498,79 +101821,69 @@ "type": "string" }, { - "description": "the tags for the network offering", - "name": "tags", - "type": "string" - }, - { - "description": "true if network offering supports public access for guest networks", - "name": "supportsinternallb", + "description": "true if network offering can be used by NSX networks only", + "name": "fornsx", "type": "boolean" }, { - "description": "the id of the network offering", - "name": "id", + "description": "availability of the network offering", + "name": "availability", "type": "string" }, { - "description": "data transfer rate in megabits per second allowed.", - "name": "networkrate", + "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": "true if network offering is ip conserve mode enabled", - "name": "conservemode", + "description": "true if network offering supports public access for guest networks", + "name": "supportsinternallb", "type": "boolean" }, { - "description": "true if network offering can be used by NSX networks only", - "name": "fornsx", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "guest type of the network offering, can be Shared or Isolated", - "name": "guestiptype", + "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domain", "type": "string" }, { - "description": "the date this network offering was created", - "name": "created", - "type": "date" - }, - { - "description": "true if network offering supports specifying ip ranges, false otherwise", - "name": "specifyipranges", - "type": "boolean" - }, - { - "description": "true if network offering supports network that span multiple zones", - "name": "supportsstrechedl2subnet", - "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": "availability of the network offering", - "name": "availability", + "description": "the traffic type for the network offering, supported types are Public, Management, Control, Guest, Vlan or Storage.", + "name": "traffictype", "type": "string" }, { - "description": "the routing mode for the network offering, supported types are Static or Dynamic.", - "name": "routingmode", - "type": "string" + "description": "true if network offering is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "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": "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" }, - {}, { - "description": "an alternate display text of the network offering.", - "name": "displaytext", + "description": "the tags for the network offering", + "name": "tags", "type": "string" }, { @@ -101579,34 +101892,19 @@ "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 internet protocol of the network offering", + "name": "internetprotocol", "type": "string" }, { - "description": "true if network offering is default, false otherwise", - "name": "isdefault", + "description": "true if network offering supports network that span multiple zones", + "name": "supportsstrechedl2subnet", "type": "boolean" }, { - "description": "the ID of the service offering used by virtual router provider", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "additional key/value details tied with network offering", - "name": "details", - "type": "map" - }, - { - "description": "the internet protocol of the network offering", - "name": "internetprotocol", - "type": "string" - }, - { - "description": "the traffic type for the network offering, supported types are Public, Management, Control, Guest, Vlan or Storage.", - "name": "traffictype", - "type": "string" + "description": "true if network offering can be used by VPC networks only", + "name": "forvpc", + "type": "boolean" } ] }, @@ -101615,13 +101913,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,76 +101920,83 @@ "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", + "description": "the out-of-band management driver for the host", + "name": "driver", "type": "string" }, - { - "description": "the operation result", - "name": "status", - "type": "boolean" - }, - {}, { "description": "the out-of-band management interface powerState of the host", "name": "powerstate", "type": "powerstate" }, { - "description": "the out-of-band management driver for the host", - "name": "driver", + "description": "the operation result description", + "name": "description", "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 address", - "name": "address", + "description": "the ID of the host", + "name": "hostid", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the out-of-band management interface port", "name": "port", "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 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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if out-of-band management is enabled for the host", + "name": "enabled", + "type": "boolean" }, { "description": "the out-of-band management interface password", "name": "password", "type": "string" }, + {}, + {}, { - "description": "the ID of the host", - "name": "hostid", + "description": "the out-of-band management interface address", + "name": "address", "type": "string" + }, + { + "description": "the operation result", + "name": "status", + "type": "boolean" } ], "since": "4.9.0" @@ -101709,31 +102007,25 @@ "name": "listResourceDetails", "params": [ { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", - "length": 255, - "name": "listall", - "required": false, - "type": "boolean" - }, - { - "description": "list by key", + "description": "", "length": 255, - "name": "key", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "list by resource id", + "description": "list by key, value. Needs to be passed only along with key", "length": 255, - "name": "resourceid", + "name": "value", "required": false, + "since": "4.4", "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "list by resource type", "length": 255, - "name": "account", - "required": false, + "name": "resourcetype", + "required": true, "type": "string" }, { @@ -101753,46 +102045,38 @@ "type": "uuid" }, { - "description": "list by resource type", + "description": "list by resource id", "length": 255, - "name": "resourcetype", - "required": true, + "name": "resourceid", + "required": false, "type": "string" }, { - "description": "List by keyword", + "description": "list by key", "length": 255, - "name": "keyword", + "name": "key", "required": false, "type": "string" }, { - "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": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "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 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" }, { @@ -101802,29 +102086,42 @@ "related": "createProject", "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, + "type": "boolean" } ], "related": "", "response": [ { - "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": "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": "tag key name", - "name": "key", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -101833,169 +102130,200 @@ "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "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": "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": "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": "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": "the account associated with the tag", - "name": "account", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ], "since": "4.2" }, { - "description": "Creates a network offering.", - "isasync": false, - "name": "createNetworkOffering", + "description": "Dedicate an existing cluster", + "isasync": true, + "name": "dedicateCluster", "params": [ { - "description": "true if the network offering is IP conserve mode enabled", + "description": "the ID of the containing domain", "length": 255, - "name": "conservemode", - "required": false, - "type": "boolean" + "name": "domainid", + "related": "createDomain,listDomains,listDomains", + "required": true, + "type": "uuid" }, { - "description": "services supported by the network offering", + "description": "the ID of the Cluster", "length": 255, - "name": "supportedservices", - "required": false, - "type": "list" + "name": "clusterid", + "related": "addCluster,updateCluster", + "required": true, + "type": "uuid" }, { - "description": "the routing mode for the network offering. Supported types are: Static or Dynamic.", + "description": "the name of the account which needs dedication. Must be used with domainId.", "length": 255, - "name": "routingmode", + "name": "account", "required": false, - "since": "4.20.0", + "type": "string" + } + ], + "related": "listDedicatedClusters", + "response": [ + { + "description": "the domain ID of the cluster", + "name": "domainid", "type": "string" }, { - "description": "set to true if the offering is to be enabled during creation. Default is false", - "length": 255, - "name": "enable", - "required": false, - "since": "4.16", - "type": "boolean" + "description": "the Account ID of the cluster", + "name": "accountid", + "type": "string" }, + {}, { - "description": "the tags for the network offering.", - "length": 4096, - "name": "tags", - "required": false, + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "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": "the ID of the dedicated resource", + "name": "id", + "type": "string" }, { - "description": "true if network offering supports persistent networks; defaulted to false if not specified", + "description": "the ID of the cluster", + "name": "clusterid", + "type": "string" + }, + { + "description": "the name of the cluster", + "name": "clustername", + "type": "string" + }, + {}, + { + "description": "the Dedication Affinity Group ID of the cluster", + "name": "affinitygroupid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ] + }, + { + "description": "Creates a network offering.", + "isasync": false, + "name": "createNetworkOffering", + "params": [ + { + "description": "true if guest network default egress policy is allow; false if default egress policy is deny", "length": 255, - "name": "ispersistent", + "name": "egressdefaultpolicy", "required": false, "type": "boolean" }, { - "description": "desired service capabilities as part of network offering", + "description": "maximum number of concurrent connections supported by the network offering", "length": 255, - "name": "servicecapabilitylist", + "name": "maxconnections", "required": false, - "type": "map" + "type": "integer" }, { - "description": "true if guest network default egress policy is allow; false if default egress policy is deny", + "description": "true if the network offering is IP conserve mode enabled", "length": 255, - "name": "egressdefaultpolicy", + "name": "conservemode", "required": false, "type": "boolean" }, { - "description": "true if network offering supports choosing AS number", + "description": "data transfer rate in megabits per second allowed", "length": 255, - "name": "specifyasnumber", + "name": "networkrate", "required": false, - "since": "4.20.0", - "type": "boolean" + "type": "integer" }, { - "description": "the traffic type for the network offering. Supported type in current release is GUEST only", + "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": "traffictype", - "required": true, + "name": "availability", + "required": false, "type": "string" }, { - "description": "guest type of the network offering: Shared or Isolated", + "description": "true if network offering supports specifying ip ranges; defaulted to false if not specified", "length": 255, - "name": "guestiptype", + "name": "specifyipranges", + "required": false, + "type": "boolean" + }, + { + "description": "the name of the network offering", + "length": 255, + "name": "name", "required": true, "type": "string" }, { - "description": "true if network offering supports vlans", + "description": "true if network offering supports persistent networks; defaulted to false if not specified", "length": 255, - "name": "specifyvlan", + "name": "ispersistent", "required": false, "type": "boolean" }, { - "description": "true if network offering for NSX network offering supports Load balancer service.", + "description": "true if network offering for NSX network offering supports Internal Load balancer service.", "length": 255, - "name": "nsxsupportlb", + "name": "nsxsupportsinternallb", "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": "true if network offering is meant to be used for VPC, false otherwise.", "length": 255, - "name": "serviceproviderlist", + "name": "forvpc", "required": false, - "type": "map" + "type": "boolean" }, { "description": "the ID of the containing domain(s), null for public offerings", @@ -102006,26 +102334,28 @@ "type": "list" }, { - "description": "The internet protocol of network offering. Options are ipv4 and dualstack. Default is ipv4. dualstack will create a network offering that supports both IPv4 and IPv6", + "description": "the service offering ID used by virtual router provider", "length": 255, - "name": "internetprotocol", + "name": "serviceofferingid", + "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", "required": false, - "since": "4.17.0", - "type": "string" + "type": "uuid" }, { - "description": "data transfer rate in megabits per second allowed", + "description": "the ID of the containing zone(s), null for public offerings", "length": 255, - "name": "networkrate", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "integer" + "since": "4.13", + "type": "list" }, { - "description": "maximum number of concurrent connections supported by the network offering", + "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": "maxconnections", + "name": "keepaliveenabled", "required": false, - "type": "integer" + "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", @@ -102036,12 +102366,26 @@ "type": "map" }, { - "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": "availability", + "description": "the tags for the network offering.", + "length": 4096, + "name": "tags", "required": false, "type": "string" }, + { + "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": "true if network offering is meant to be used for Tungsten-Fabric, false otherwise.", + "length": 255, + "name": "fortungsten", + "required": false, + "type": "boolean" + }, { "description": "Name of the provider providing the service", "length": 255, @@ -102050,6 +102394,13 @@ "since": "4.21.0", "type": "string" }, + { + "description": "guest type of the network offering: Shared or Isolated", + "length": 255, + "name": "guestiptype", + "required": true, + "type": "string" + }, { "description": "Indicates the mode with which the network will operate. Valid option: NATTED or ROUTED", "length": 255, @@ -102059,51 +102410,65 @@ "type": "string" }, { - "description": "the ID of the containing zone(s), null for public offerings", + "description": "true if network offering supports vlans", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "specifyvlan", "required": false, - "since": "4.13", - "type": "list" + "type": "boolean" }, { - "description": "true if network offering is meant to be used for NSX, false otherwise.", + "description": "true if network offering supports choosing AS number", "length": 255, - "name": "fornsx", + "name": "specifyasnumber", "required": false, "since": "4.20.0", "type": "boolean" }, { - "description": "true if network offering for NSX network offering supports Internal Load balancer service.", + "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": "nsxsupportsinternallb", + "name": "serviceproviderlist", + "required": false, + "type": "map" + }, + { + "description": "the routing mode for the network offering. Supported types are: Static or Dynamic.", + "length": 255, + "name": "routingmode", "required": false, "since": "4.20.0", - "type": "boolean" + "type": "string" }, { - "description": "true if network offering is meant to be used for VPC, false otherwise.", + "description": "The internet protocol of network offering. Options are ipv4 and dualstack. Default is ipv4. dualstack will create a network offering that supports both IPv4 and IPv6", "length": 255, - "name": "forvpc", + "name": "internetprotocol", "required": false, - "type": "boolean" + "since": "4.17.0", + "type": "string" }, { - "description": "true if network offering supports specifying ip ranges; defaulted to false if not specified", + "description": "true if network offering for NSX network offering supports Load balancer service.", "length": 255, - "name": "specifyipranges", + "name": "nsxsupportlb", "required": false, + "since": "4.20.0", "type": "boolean" }, { - "description": "the service offering ID used by virtual router provider", + "description": "services supported by the network offering", "length": 255, - "name": "serviceofferingid", - "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", + "name": "supportedservices", "required": false, - "type": "uuid" + "type": "list" + }, + { + "description": "set to true if the offering is to be enabled during creation. Default is false", + "length": 255, + "name": "enable", + "required": false, + "since": "4.16", + "type": "boolean" }, { "description": "the display text of the network offering, defaults to the value of 'name'.", @@ -102113,38 +102478,31 @@ "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": "desired service capabilities as part of network offering", "length": 255, - "name": "keepaliveenabled", + "name": "servicecapabilitylist", + "required": false, + "type": "map" + }, + { + "description": "true if network offering is meant to be used for NSX, false otherwise.", + "length": 255, + "name": "fornsx", "required": false, + "since": "4.20.0", "type": "boolean" } ], "related": "listNetworkOfferings", "response": [ { - "description": "true if network offering can be used by VPC networks only", - "name": "forvpc", - "type": "boolean" - }, - { - "description": "Mode in which the network will operate. The valid values are NATTED and ROUTED", - "name": "networkmode", + "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 supports vlans, false otherwise", - "name": "specifyvlan", - "type": "boolean" - }, - { - "description": "true if network offering supports persistent networks, false otherwise", - "name": "ispersistent", - "type": "boolean" - }, - { - "description": "guest type of the network offering, can be Shared or Isolated", - "name": "guestiptype", + "description": "the name of the network offering", + "name": "name", "type": "string" }, { @@ -102152,84 +102510,76 @@ "name": "networkrate", "type": "integer" }, + {}, { - "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zone", - "type": "string" - }, - { - "description": "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", - "type": "string" - }, - { - "description": "the tags for the network offering", - "name": "tags", + "description": "guest type of the network offering, can be Shared or Isolated", + "name": "guestiptype", "type": "string" }, - { - "description": "true if network offering supports choosing AS numbers", - "name": "specifyasnumber", - "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", - "type": "boolean" - }, - {}, { "description": "the list of supported services", "name": "service", "response": [ { - "description": "the service provider name", - "name": "provider", + "description": "the list of capabilities", + "name": "capability", "response": [ { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "the capability name", + "name": "name", "type": "string" }, { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", + "description": "the capability value", + "name": "value", "type": "string" }, { - "description": "services for this provider", - "name": "servicelist", - "type": "list" + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" + } + ], + "type": "list" + }, + { + "description": "the service provider name", + "name": "provider", + "response": [ + { + "description": "state of the network provider", + "name": "state", + "type": "string" }, { "description": "uuid of the network provider", "name": "id", "type": "string" }, + { + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", + "type": "string" + }, { "description": "the provider name", "name": "name", "type": "string" }, { - "description": "state of the network provider", - "name": "state", - "type": "string" + "description": "services for this provider", + "name": "servicelist", + "type": "list" }, { "description": "true if individual services can be enabled/disabled", "name": "canenableindividualservice", "type": "boolean" + }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" } ], "type": "list" @@ -102238,106 +102588,94 @@ "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" } ], "type": "list" }, { - "description": "an alternate display text of the network offering.", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the ID of the service offering used by virtual router provider", - "name": "serviceofferingid", + "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domain", "type": "string" }, { - "description": "true if network offering can be used by Tungsten-Fabric networks only", - "name": "fortungsten", - "type": "boolean" + "description": "the tags for the network offering", + "name": "tags", + "type": "string" }, { - "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 name of the network offering", - "name": "name", + "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domainid", "type": "string" }, { - "description": "true if guest network default egress policy is allow; false if default egress policy is deny", - "name": "egressdefaultpolicy", + "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": "state of the network offering. Can be Disabled/Enabled/Inactive", - "name": "state", + "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zone", "type": "string" }, { - "description": "the routing mode for the network offering, supported types are Static or Dynamic.", - "name": "routingmode", - "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 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 vlans, false otherwise", + "name": "specifyvlan", + "type": "boolean" }, { - "description": "true if network offering supports network that span multiple zones", - "name": "supportsstrechedl2subnet", + "description": "true if network offering is default, false otherwise", + "name": "isdefault", "type": "boolean" }, { - "description": "true if network offering can be used by NSX networks only", - "name": "fornsx", + "description": "true if network offering supports network that span multiple zones", + "name": "supportsstrechedl2subnet", "type": "boolean" }, { - "description": "additional key/value details tied with network offering", - "name": "details", - "type": "map" + "description": "the date this network offering was created", + "name": "created", + "type": "date" }, { "description": "the traffic type for the network offering, supported types are Public, Management, Control, Guest, Vlan or Storage.", "name": "traffictype", "type": "string" }, + {}, { - "description": "true if network offering supports specifying ip ranges, false otherwise", - "name": "specifyipranges", + "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", "type": "boolean" }, { @@ -102346,117 +102684,77 @@ "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the date this network offering was created", - "name": "created", - "type": "date" - }, - { - "description": "availability of the network offering", - "name": "availability", - "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 internet protocol of the network offering", - "name": "internetprotocol", + "description": "an alternate display text of the network offering.", + "name": "displaytext", "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 specifying ip ranges, false otherwise", + "name": "specifyipranges", + "type": "boolean" }, { - "description": "true if network offering supports public access for guest networks", - "name": "supportsinternallb", + "description": "true if guest network default egress policy is allow; false if default egress policy is deny", + "name": "egressdefaultpolicy", "type": "boolean" - } - ], - "since": "3.0.0" - }, - { - "description": "Dedicate an existing cluster", - "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": "true if network offering can be used by Tungsten-Fabric networks only", + "name": "fortungsten", + "type": "boolean" }, { - "description": "the name of the account which needs dedication. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, + "description": "availability of the network offering", + "name": "availability", "type": "string" }, { - "description": "the ID of the Cluster", - "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", - "required": true, - "type": "uuid" - } - ], - "related": "listDedicatedClusters", - "response": [ - {}, - {}, - { - "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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the ID of the service offering used by virtual router provider", + "name": "serviceofferingid", + "type": "string" }, { - "description": "the domain ID of the cluster", - "name": "domainid", + "description": "the id of the network offering", + "name": "id", "type": "string" }, { - "description": "the name of the cluster", - "name": "clustername", - "type": "string" + "description": "true if network offering supports public access for guest networks", + "name": "supportsinternallb", + "type": "boolean" }, { - "description": "the ID of the cluster", - "name": "clusterid", - "type": "string" + "description": "true if network offering can be used by VPC networks only", + "name": "forvpc", + "type": "boolean" }, { - "description": "the Account ID of the cluster", - "name": "accountid", + "description": "the internet protocol of the network offering", + "name": "internetprotocol", "type": "string" }, { - "description": "the ID of the dedicated resource", - "name": "id", + "description": "state of the network offering. Can be Disabled/Enabled/Inactive", + "name": "state", "type": "string" }, { - "description": "the Dedication Affinity Group ID of the cluster", - "name": "affinitygroupid", - "type": "string" + "description": "true if network offering is ip conserve mode enabled", + "name": "conservemode", + "type": "boolean" + }, + { + "description": "true if network offering can be used by NSX networks only", + "name": "fornsx", + "type": "boolean" } - ] + ], + "since": "3.0.0" }, { "description": "Creates an IP forwarding rule", @@ -102464,11 +102762,11 @@ "name": "createIpForwardingRule", "params": [ { - "description": "the start port for the rule", + "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": "startport", - "required": true, - "type": "integer" + "name": "cidrlist", + "required": false, + "type": "list" }, { "description": "the end port for the rule", @@ -102477,13 +102775,6 @@ "required": false, "type": "integer" }, - { - "description": "the CIDR list to forward traffic from. Multiple entries must be separated by a single comma character (,). This parameter is deprecated. Do not use.", - "length": 255, - "name": "cidrlist", - "required": false, - "type": "list" - }, { "description": "if true, firewall rule for source/end public port is automatically created; if false - firewall rule has to be created explicitly. Has value true by default", "length": 255, @@ -102491,6 +102782,13 @@ "required": false, "type": "boolean" }, + { + "description": "the protocol for the rule. Valid values are TCP or UDP.", + "length": 255, + "name": "protocol", + "required": true, + "type": "string" + }, { "description": "the public IP address ID of the forwarding rule, already associated via associateIp", "length": 255, @@ -102500,21 +102798,15 @@ "type": "uuid" }, { - "description": "the protocol for the rule. Valid values are TCP or UDP.", + "description": "the start port for the rule", "length": 255, - "name": "protocol", + "name": "startport", "required": true, - "type": "string" + "type": "integer" } ], "related": "createPortForwardingRule,updatePortForwardingRule", "response": [ - {}, - { - "description": "the id of the guest network the port forwarding rule belongs to", - "name": "networkid", - "type": "string" - }, { "description": "the VM name for the port forwarding rule", "name": "virtualmachinename", @@ -102525,45 +102817,75 @@ "name": "id", "type": "string" }, + { + "description": "the starting port of port forwarding rule's private port range", + "name": "privateport", + "type": "string" + }, + { + "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": "privateendport", "type": "string" }, { - "description": "the starting port of port forwarding rule's public port range", - "name": "publicport", + "description": "the VM display name for the port forwarding rule", + "name": "virtualmachinedisplayname", + "type": "string" + }, + { + "description": "the 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 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 protocol of the port forwarding rule", + "name": "protocol", "type": "string" }, { - "description": "the public ip address id for the port forwarding rule", - "name": "ipaddressid", + "description": "the ending port of port forwarding rule's private port range", + "name": "publicendport", "type": "string" }, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the vm 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 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 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 state of the rule", + "name": "state", "type": "string" }, { @@ -102571,18 +102893,24 @@ "name": "virtualmachineid", "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": "resource type", - "name": "resourcetype", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -102591,23 +102919,23 @@ "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": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -102616,52 +102944,22 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "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" } ], "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,20 +102979,18 @@ "related": "listElastistorVolume", "response": [ { - "description": "graceallowed", - "name": "graceallowed", + "description": "the id of the volume", + "name": "id", "type": "string" }, { - "description": "compression", - "name": "compression", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, - {}, { - "description": "the id of the volume", - "name": "id", + "description": "compression", + "name": "compression", "type": "string" }, { @@ -102702,14 +102998,15 @@ "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": "synchronization", - "name": "sync", + "description": "graceallowed", + "name": "graceallowed", "type": "string" }, { @@ -102717,10 +103014,11 @@ "name": "deduplication", "type": "string" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "synchronization", + "name": "sync", + "type": "string" } ] }, @@ -102729,20 +103027,6 @@ "isasync": false, "name": "quotaStatement", "params": [ - { - "description": "Optional, Account Id for which statement needs to be generated", - "length": 255, - "name": "account", - "required": true, - "type": "string" - }, - { - "description": "List quota usage records for the specified usage type", - "length": 255, - "name": "type", - "required": false, - "type": "integer" - }, { "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, @@ -102759,11 +103043,18 @@ "type": "uuid" }, { - "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", + "name": "type", + "required": false, + "type": "integer" + }, + { + "description": "Optional, Account Id for which statement needs to be generated", + "length": 255, + "name": "account", "required": true, - "type": "date" + "type": "string" }, { "description": "Optional, If domain Id is given and the caller is domain admin then the statement is generated for domain.", @@ -102772,55 +103063,62 @@ "related": "createDomain,listDomains,listDomains", "required": true, "type": "uuid" + }, + { + "description": "Start of the period of the Quota statement. The recommended format is \"yyyy-MM-dd'T'HH:mm:ssZ\" (e.g.: \"2023-01-01T12:00:00+0100\"); however, the following formats are also accepted: \"yyyy-MM-dd HH:mm:ss\" (e.g.: \"2023-01-01 12:00:00\") and \"yyyy-MM-dd\" (e.g.: \"2023-01-01\" - if the time is not added, it will be interpreted as \"00:00:00\"). If the recommended format is not used, the date will be considered in the server timezone.", + "length": 255, + "name": "startdate", + "required": true, + "type": "date" } ], "related": "", "response": [ - {}, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "usage type name", + "name": "name", + "type": "string" }, { - "description": "domain id", - "name": "domain", - "type": "long" + "description": "account name", + "name": "account", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "quota consumed", + "name": "quota", + "type": "bigdecimal" }, + {}, { - "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", - "type": "string" + "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": "domain id", + "name": "domain", + "type": "long" }, { - "description": "quota consumed", - "name": "quota", - "type": "bigdecimal" + "description": "usage unit", + "name": "unit", + "type": "string" }, { - "description": "usage type name", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ], @@ -102840,32 +103138,52 @@ "type": "uuid" }, { - "description": "an optional field, whether to the display the 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": "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 policy to the end user or not", "length": 255, - "name": "customid", + "name": "fordisplay", "required": false, "since": "4.4", - "type": "string" + "type": "boolean" } ], "related": "createLBStickinessPolicy", "response": [ + { + "description": "the state of the policy", + "name": "state", + "type": "string" + }, { "description": "the id of the zone the Stickiness policy belongs to", "name": "zoneid", "type": "string" }, { - "description": "the domain ID of the Stickiness policy", - "name": "domainid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "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", + "type": "string" + }, + { + "description": "the LB rule ID", + "name": "lbruleid", "type": "string" }, { @@ -102873,58 +103191,52 @@ "name": "stickinesspolicy", "response": [ { - "description": "the state of the policy", - "name": "state", - "type": "string" + "description": "the params of the policy", + "name": "params", + "type": "map" }, { - "description": "the LB Stickiness policy ID", - "name": "id", + "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": "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 method name of the Stickiness policy", - "name": "methodname", - "type": "string" - }, - { - "description": "the name of the Stickiness policy", - "name": "name", + "description": "the LB Stickiness policy ID", + "name": "id", "type": "string" } ], "type": "list" }, + {}, { - "description": "the account of the Stickiness policy", - "name": "account", - "type": "string" - }, - { - "description": "the LB rule ID", - "name": "lbruleid", + "description": "the domain ID of the Stickiness policy", + "name": "domainid", "type": "string" }, - {}, - {}, { - "description": "the state of the policy", - "name": "state", + "description": "the account of the Stickiness policy", + "name": "account", "type": "string" }, { @@ -102932,21 +103244,7 @@ "name": "name", "type": "string" }, - { - "description": "the description of the Stickiness policy", - "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 domain of the Stickiness policy", "name": "domain", @@ -102961,40 +103259,40 @@ "name": "listPods", "params": [ { - "description": "list pods by allocation state", + "description": "the name of the storage access group", "length": 255, - "name": "allocationstate", + "name": "storageaccessgroup", "required": false, + "since": "4.21.0", "type": "string" }, { - "description": "list Pods by name", + "description": "List by keyword", "length": 255, - "name": "name", + "name": "keyword", "required": false, "type": "string" }, { - "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", + "description": "list Pods by name", "length": 255, - "name": "id", - "related": "listPods,createManagementNetworkIpRange", + "name": "name", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "", + "description": "flag to display the capacity of the pods", "length": 255, - "name": "pagesize", + "name": "showcapacities", "required": false, - "type": "integer" + "type": "boolean" }, { "description": "", @@ -103004,12 +103302,11 @@ "type": "integer" }, { - "description": "the name of the storage access group", + "description": "", "length": 255, - "name": "storageaccessgroup", + "name": "pagesize", "required": false, - "since": "4.21.0", - "type": "string" + "type": "integer" }, { "description": "list Pods by Zone ID", @@ -103020,58 +103317,23 @@ "type": "uuid" }, { - "description": "flag to display the capacity of the pods", + "description": "list Pods by ID", "length": 255, - "name": "showcapacities", + "name": "id", + "related": "listPods,createManagementNetworkIpRange", "required": false, - "type": "boolean" + "type": "uuid" } ], "related": "createManagementNetworkIpRange", "response": [ - {}, - { - "description": "the gateway of the Pod", - "name": "gateway", - "type": "string" - }, - { - "description": "the Zone name of the Pod", - "name": "zonename", - "type": "string" - }, - { - "description": "the ID of the Pod", - "name": "id", - "type": "string" - }, - { - "description": "the name of the Pod", - "name": "name", - "type": "string" - }, - { - "description": "the Zone ID of the Pod", - "name": "zoneid", - "type": "string" - }, - { - "description": "indicates if range is dedicated for CPVM and SSVM. This parameter is deprecated, please use 'forsystemvms' from ipranges parameter.", - "name": "forsystemvms", - "type": "list" - }, - { - "description": "comma-separated list of storage access groups on the zone", - "name": "zonestorageaccessgroups", - "type": "string" - }, { "description": "the IP ranges for the Pod", "name": "ipranges", "response": [ { - "description": "the gateway for the range", - "name": "gateway", + "description": "the CIDR for the range", + "name": "cidr", "type": "string" }, { @@ -103080,8 +103342,8 @@ "type": "string" }, { - "description": "the CIDR for the range", - "name": "cidr", + "description": "indicates Vlan ID for the range", + "name": "vlanid", "type": "string" }, { @@ -103090,75 +103352,77 @@ "type": "string" }, { - "description": "the ending IP for the range", - "name": "endip", + "description": "the gateway for the range", + "name": "gateway", "type": "string" }, { - "description": "indicates Vlan ID for the range", - "name": "vlanid", + "description": "the ending IP for the range", + "name": "endip", "type": "string" } ], "type": "list" }, { - "description": "the starting IP for the Pod. This parameter is deprecated, please use 'startip' from ipranges parameter.", - "name": "startip", + "description": "indicates if range is dedicated for CPVM and SSVM. This parameter is deprecated, please use 'forsystemvms' from ipranges parameter.", + "name": "forsystemvms", "type": "list" }, + {}, { - "description": "the netmask of the Pod", - "name": "netmask", + "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 Zone name of the Pod", + "name": "zonename", "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 on the zone", + "name": "zonestorageaccessgroups", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the allocation state of the Pod", + "name": "allocationstate", + "type": "string" }, { - "description": "the current status of the latest 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 capacity of the Pod", "name": "capacity", "response": [ { - "description": "the Pod ID", - "name": "podid", + "description": "the Cluster ID", + "name": "clusterid", "type": "string" }, { - "description": "the capacity currently in use", - "name": "capacityused", - "type": "long" - }, - { - "description": "the Zone name", - "name": "zonename", + "description": "The tag for the capacity type", + "name": "tag", "type": "string" }, { - "description": "the total capacity available", - "name": "capacitytotal", + "description": "the capacity currently in allocated", + "name": "capacityallocated", "type": "long" }, { - "description": "the Pod name", - "name": "podname", - "type": "string" - }, - { - "description": "the capacity name", - "name": "name", + "description": "the Pod ID", + "name": "podid", "type": "string" }, { @@ -103167,58 +103431,92 @@ "type": "string" }, { - "description": "the capacity currently in allocated", - "name": "capacityallocated", - "type": "long" + "description": "the capacity type", + "name": "type", + "type": "short" }, { - "description": "The tag for the capacity type", - "name": "tag", + "description": "the Cluster name", + "name": "clustername", "type": "string" }, { - "description": "the Cluster name", - "name": "clustername", + "description": "the Zone name", + "name": "zonename", "type": "string" }, { - "description": "the Cluster ID", - "name": "clusterid", + "description": "the Pod name", + "name": "podname", "type": "string" }, { - "description": "the capacity type", - "name": "type", - "type": "short" + "description": "the capacity name", + "name": "name", + "type": "string" }, { "description": "the percentage of capacity currently in use", "name": "percentused", "type": "string" + }, + { + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" + }, + { + "description": "the total capacity available", + "name": "capacitytotal", + "type": "long" } ], "type": "list" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the gateway of the Pod", + "name": "gateway", "type": "string" }, - {}, { - "description": "indicates Vlan ID for the range. This parameter is deprecated, please use 'vlanid' from ipranges parameter.", - "name": "vlanid", + "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", + "description": "the ending IP for the Pod. This parameter is deprecated, please use 'endip' from ipranges parameter.", + "name": "endip", + "type": "list" + }, + { + "description": "the name of the Pod", + "name": "name", + "type": "string" + }, + { + "description": "the netmask of the Pod", + "name": "netmask", "type": "string" }, { "description": "comma-separated list of storage access groups for the pod", "name": "storageaccessgroups", "type": "string" + }, + { + "description": "the Zone ID of the Pod", + "name": "zoneid", + "type": "string" + }, + { + "description": "the ID of the Pod", + "name": "id", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" } ] }, @@ -103228,44 +103526,44 @@ "name": "deleteTungstenFabricAddressGroup", "params": [ { - "description": "the ID of zone", + "description": "the uuid of Tungsten-Fabric address group", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "addressgroupuuid", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "the uuid of Tungsten-Fabric address group", + "description": "the ID of zone", "length": 255, - "name": "addressgroupuuid", + "name": "zoneid", + "related": "listZones", "required": true, - "type": "string" + "type": "uuid" } ], "response": [ - {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "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" + }, + {}, + {} ] }, { @@ -103282,12 +103580,11 @@ "type": "boolean" }, { - "description": "The name of the quota tariff.", + "description": "", "length": 255, - "name": "name", + "name": "pagesize", "required": false, - "since": "4.18.0.0", - "type": "string" + "type": "integer" }, { "description": "The start date of the quota tariff. The recommended format is \"yyyy-MM-dd'T'HH:mm:ssZ\" (e.g.: \"2023-01-01T12:00:00+0100\"); however, the following formats are also accepted: \"yyyy-MM-dd HH:mm:ss\" (e.g.: \"2023-01-01 12:00:00\") and \"yyyy-MM-dd\" (e.g.: \"2023-01-01\" - if the time is not added, it will be interpreted as \"00:00:00\"). If the recommended format is not used, the date will be considered in the server timezone.", @@ -103297,81 +103594,82 @@ "type": "date" }, { - "description": "", + "description": "The quota tariff's id.", "length": 255, - "name": "page", + "name": "id", "required": false, - "type": "integer" + "type": "string" }, { - "description": "The quota tariff's id.", + "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, - "name": "id", + "name": "enddate", "required": false, - "type": "string" + "since": "4.18.0.0", + "type": "date" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "If set to true, we will list only the removed tariffs. The default is false.", + "description": "The name of the quota tariff.", "length": 255, - "name": "listonlyremoved", + "name": "name", "required": false, - "type": "boolean" + "since": "4.18.0.0", + "type": "string" }, { - "description": "Usage type of the resource", + "description": "List by keyword", "length": 255, - "name": "usagetype", + "name": "keyword", "required": false, - "type": "integer" + "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.", + "description": "If set to true, we will list only the removed tariffs. The default is false.", "length": 255, - "name": "enddate", + "name": "listonlyremoved", "required": false, - "since": "4.18.0.0", - "type": "date" + "type": "boolean" }, { - "description": "List by keyword", + "description": "Usage type of the resource", "length": 255, - "name": "keyword", + "name": "usagetype", "required": false, - "type": "string" + "type": "integer" } ], "related": "", "response": [ { - "description": "position in the execution sequence for tariffs of the same type", - "name": "position", - "type": "integer" + "description": "tariffValue", + "name": "tariffValue", + "type": "bigdecimal" }, { - "description": "description", - "name": "description", + "description": "the ID of the tariff", + "name": "id", "type": "string" }, { - "description": "activation rule of the quota tariff", - "name": "activationRule", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "tariffValue", - "name": "tariffValue", - "type": "bigdecimal" + "description": "usageType", + "name": "usageType", + "type": "int" }, { - "description": "currency", - "name": "currency", + "description": "name", + "name": "name", "type": "string" }, { @@ -103379,15 +103677,14 @@ "name": "removed", "type": "date" }, - {}, { - "description": "the end date of the quota tariff", - "name": "endDate", - "type": "date" + "description": "activation rule of the quota tariff", + "name": "activationRule", + "type": "string" }, { - "description": "usageName", - "name": "usageName", + "description": "usageDiscriminator", + "name": "usageDiscriminator", "type": "string" }, { @@ -103396,44 +103693,45 @@ "type": "date" }, { - "description": "name", - "name": "name", + "description": "usageName", + "name": "usageName", "type": "string" }, { - "description": "usageUnit", - "name": "usageUnit", + "description": "position in the execution sequence for tariffs of the same type", + "name": "position", + "type": "integer" + }, + { + "description": "description", + "name": "description", "type": "string" }, + {}, { "description": "usage type description", "name": "usageTypeDescription", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "usageUnit", + "name": "usageUnit", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the ID of the tariff", - "name": "id", + "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": "usageDiscriminator", - "name": "usageDiscriminator", + "description": "currency", + "name": "currency", "type": "string" } ], @@ -103454,15 +103752,16 @@ } ], "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" }, {}, { @@ -103471,11 +103770,10 @@ "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" + } ] }, { @@ -103493,11 +103791,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", @@ -103505,16 +103809,137 @@ }, {}, { - "description": "true if operation is executed successfully", - "name": "success", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } + ], + "since": "4.21.0" + }, + { + "description": "Delete the extensions", + "isasync": false, + "name": "deleteExtension", + "params": [ + { + "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", + "required": false, "type": "boolean" }, + { + "description": "ID of the extension", + "length": 255, + "name": "id", + "related": "listExtensions,deleteExtension,updateExtension,unregisterExtension", + "required": false, + "type": "uuid" + } + ], + "related": "listExtensions,updateExtension,unregisterExtension", + "response": [ + { + "description": "Name of the extension", + "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": "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 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": "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": "Type of the resource", + "name": "type", + "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" + } + ], + "type": "list" + }, + { + "description": "The details of the extension", + "name": "details", + "type": "map" + }, + {}, + { + "description": "ID of the extension", + "name": "id", + "type": "string" + }, + { + "description": "The state of the extension", + "name": "state", + "type": "string" + }, + { + "description": "Type of the extension", + "name": "type", + "type": "string" + }, + { + "description": "True if the extension path is in ready state across management servers", + "name": "pathready", + "type": "boolean" + } ], "since": "4.21.0" }, @@ -103524,84 +103949,94 @@ "name": "listIpv4SubnetsForZone", "params": [ { - "description": "the domain ID which the IPv4 subnet is dedicated to.", + "description": "CIDR of the IPv4 subnet.", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains", + "name": "subnet", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "project who which the IPv4 subnet is dedicated to", + "description": "the account which the IPv4 subnet is dedicated to. Must be used with the domainId parameter.", "length": 255, - "name": "projectid", - "related": "createProject", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "UUID of zone to which the IPv4 subnet belongs to.", + "description": "", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "List by keyword", + "description": "UUID of zone to which the IPv4 subnet belongs to.", "length": 255, - "name": "keyword", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "CIDR of the IPv4 subnet.", + "description": "", "length": 255, - "name": "subnet", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "", + "description": "UUID of the IPv4 subnet.", "length": 255, - "name": "page", + "name": "id", + "related": "listIpv4SubnetsForZone,dedicateIpv4SubnetForZone", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "", + "description": "the domain ID which the IPv4 subnet is dedicated to.", "length": 255, - "name": "pagesize", + "name": "domainid", + "related": "createDomain,listDomains,listDomains", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "UUID of the IPv4 subnet.", + "description": "project who which the IPv4 subnet is dedicated to", "length": 255, - "name": "id", - "related": "listIpv4SubnetsForZone,dedicateIpv4SubnetForZone", + "name": "projectid", + "related": "createProject", "required": false, "type": "uuid" }, { - "description": "the account which the IPv4 subnet is dedicated to. Must be used with the domainId parameter.", + "description": "List by keyword", "length": 255, - "name": "account", + "name": "keyword", "required": false, "type": "string" } ], "related": "dedicateIpv4SubnetForZone", "response": [ - {}, + { + "description": "name of zone to which the IPv4 subnet belongs to.", + "name": "zonename", + "type": "string" + }, { "description": "the project id of the IPv4 subnet", "name": "projectid", "type": "string" }, + {}, { - "description": "guest IPv4 subnet", - "name": "subnet", + "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", "type": "string" }, { @@ -103610,28 +104045,19 @@ "type": "integer" }, { - "description": "id of the guest IPv4 subnet", - "name": "id", - "type": "string" - }, - { - "description": "the account of the IPv4 subnet", - "name": "account", + "description": "the project name of the IPv4 subnet", + "name": "project", "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", + "description": "guest IPv4 subnet", + "name": "subnet", "type": "string" }, { @@ -103639,20 +104065,19 @@ "name": "domainid", "type": "string" }, - {}, { - "description": "the project name of the IPv4 subnet", - "name": "project", + "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", + "description": "id of the guest IPv4 subnet", + "name": "id", "type": "string" }, { - "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" } ], @@ -103671,19 +104096,27 @@ "type": "string" }, { - "description": "ID of the project role", + "description": "Project role type to be assigned to the user - Admin/Regular; default: Regular", "length": 255, - "name": "projectroleid", - "related": "listProjectRoles,updateProjectRole", + "name": "roletype", "required": false, + "type": "string" + }, + { + "description": "ID of the project to add the account to", + "length": 255, + "name": "projectid", + "related": "createProject", + "required": true, "type": "uuid" }, { - "description": "Project role type to be assigned to the user - Admin/Regular; default: Regular", + "description": "ID of the project role", "length": 255, - "name": "roletype", + "name": "projectroleid", + "related": "listProjectRoles,updateProjectRole", "required": false, - "type": "string" + "type": "uuid" }, { "description": "email to which invitation to the project is going to be sent", @@ -103691,28 +104124,9 @@ "name": "email", "required": false, "type": "string" - }, - { - "description": "ID of the project to add the account to", - "length": 255, - "name": "projectid", - "related": "createProject", - "required": true, - "type": "uuid" } ], "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, { "description": "true if operation is executed successfully", "name": "success", @@ -103723,7 +104137,18 @@ "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": "3.0.0" }, @@ -103733,44 +104158,18 @@ "name": "listSnapshots", "params": [ { - "description": "ID of the image or image cache store", - "length": 255, - "name": "imagestoreid", - "related": "addSecondaryStorage,listSwifts,addImageStore", - "required": false, - "since": "4.19", - "type": "uuid" - }, - { - "description": "ID of the storage pool", - "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", - "required": false, - "since": "4.19", - "type": "uuid" - }, - { - "description": "list snapshots by location type. Used only when showunique=false. Valid location types: 'primary', 'secondary'. Default is empty", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "locationtype", + "name": "account", "required": false, - "since": "4.19.0", "type": "string" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", - "length": 255, - "name": "projectid", - "related": "createProject", - "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 set to false, list templates across zones and their storages", "length": 255, - "name": "listall", + "name": "showunique", "required": false, + "since": "4.19.0", "type": "boolean" }, { @@ -103781,10 +104180,11 @@ "type": "integer" }, { - "description": "valid values are MANUAL or RECURRING.", + "description": "list snapshots by location type. Used only when showunique=false. Valid location types: 'primary', 'secondary'. Default is empty", "length": 255, - "name": "snapshottype", + "name": "locationtype", "required": false, + "since": "4.19.0", "type": "string" }, { @@ -103795,25 +104195,17 @@ "type": "integer" }, { - "description": "If set to false, list templates across zones and their storages", - "length": 255, - "name": "showunique", - "required": false, - "since": "4.19.0", - "type": "boolean" - }, - { - "description": "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 only resources belonging to the domain specified", + "description": "list snapshots by zone id", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains", + "name": "zoneid", + "related": "listZones", "required": false, "type": "uuid" }, @@ -103825,25 +104217,25 @@ "type": "map" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "account", + "name": "domainid", + "related": "createDomain,listDomains,listDomains", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the ID of the disk volume", + "description": "valid values are HOURLY, DAILY, WEEKLY, and MONTHLY.", "length": 255, - "name": "volumeid", - "related": "createVolume,updateVolume,listVolumes,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", + "name": "intervaltype", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "lists snapshot by snapshot ID", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "id", - "related": "createSnapshotFromVMSnapshot,copySnapshot,archiveSnapshot,listSnapshots,listSnapshots", + "name": "projectid", + "related": "createProject", "required": false, "type": "uuid" }, @@ -103857,125 +104249,180 @@ "type": "list" }, { - "description": "List by keyword", + "description": "valid values are MANUAL or RECURRING.", "length": 255, - "name": "keyword", + "name": "snapshottype", "required": false, "type": "string" }, { - "description": "valid values are HOURLY, DAILY, WEEKLY, and MONTHLY.", + "description": "lists snapshot by snapshot name", "length": 255, - "name": "intervaltype", + "name": "name", "required": false, "type": "string" }, { - "description": "list snapshots by zone id", + "description": "ID of the image or image cache store", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "imagestoreid", + "related": "addSecondaryStorage,listSwifts,addImageStore", "required": false, + "since": "4.19", "type": "uuid" }, { - "description": "lists snapshot by snapshot name", + "description": "the ID of the disk volume", "length": 255, - "name": "name", + "name": "volumeid", + "related": "importVolume,createVolume,updateVolume,listVolumes,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", "required": false, - "type": "string" + "type": "uuid" + }, + { + "description": "ID of the storage pool", + "length": 255, + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", + "required": false, + "since": "4.19", + "type": "uuid" + }, + { + "description": "lists snapshot by snapshot ID", + "length": 255, + "name": "id", + "related": "createSnapshotFromVMSnapshot,copySnapshot,archiveSnapshot,listSnapshots,listSnapshots", + "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": "If set to false, list only resources belonging to the command's caller; if set to true - list resources 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": "createSnapshotFromVMSnapshot,copySnapshot,archiveSnapshot,listSnapshots", "response": [ { - "description": "state of the disk volume", - "name": "volumestate", + "description": "virtual size of backedup snapshot on image store", + "name": "virtualsize", + "type": "long" + }, + { + "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 os on volume", + "name": "ostypeid", "type": "string" }, + {}, { - "description": "valid location types are primary and secondary.", - "name": "locationtype", + "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": "name of the disk volume", - "name": "volumename", + "description": "valid location types are primary and secondary.", + "name": "locationtype", "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 project id of the snapshot", + "name": "projectid", + "type": "string" }, { - "description": "id of the os on volume", - "name": "ostypeid", + "description": "the domain ID of the snapshot's account", + "name": "domainid", "type": "string" }, { - "description": "ID of the datastore for the snapshot entry", - "name": "datastoreid", + "description": "valid types are hourly, daily, weekly, monthy, template, and none.", + "name": "intervaltype", "type": "string" }, { - "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "type of the disk volume", "name": "volumetype", "type": "string" }, - { - "description": "the project name of the snapshot", - "name": "project", - "type": "string" - }, { "description": "physical size of backedup snapshot on image store", "name": "physicalsize", "type": "long" }, { - "description": " the date the snapshot was created", - "name": "created", - "type": "date" + "description": "state of the disk volume", + "name": "volumestate", + "type": "string" }, { - "description": "download progress of a snapshot", - "name": "downloaddetails", - "type": "map" + "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 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" }, { - "description": "the project id of the snapshot", - "name": "projectid", + "description": "the project name of the snapshot", + "name": "project", "type": "string" }, { - "description": "the type of the snapshot", - "name": "snapshottype", + "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": " the date the snapshot was created", + "name": "created", + "type": "date" }, { - "description": "the account associated with the snapshot", - "name": "account", + "description": "display name of the os on volume", + "name": "osdisplayname", + "type": "string" + }, + { + "description": "name of the datastore for the snapshot entry", + "name": "datastorename", + "type": "string" + }, + { + "description": "the status of the template", + "name": "status", "type": "string" }, { @@ -103983,273 +104430,124 @@ "name": "tags", "response": [ { - "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": "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": "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" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "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" } ], "type": "set" }, { - "description": "the domain ID of the snapshot's account", - "name": "domainid", - "type": "string" - }, - { - "description": "display name of the os on volume", - "name": "osdisplayname", - "type": "string" - }, - { - "description": "ID of the snapshot", - "name": "id", - "type": "string" - }, - { - "description": "the domain name of the snapshot's account", - "name": "domain", - "type": "string" - }, - { - "description": "name of the datastore for the snapshot entry", - "name": "datastorename", + "description": "name of the disk volume", + "name": "volumename", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "type of the datastore for the snapshot entry", + "name": "datastoretype", "type": "string" }, { - "description": "indicates whether the underlying storage supports reverting the volume to this snapshot", - "name": "revertable", - "type": "boolean" - }, - {}, - { - "description": "valid types are hourly, daily, weekly, monthy, template, and none.", - "name": "intervaltype", - "type": "string" + "description": "download progress of a snapshot", + "name": "downloaddetails", + "type": "map" }, { "description": "ID of the disk volume", "name": "volumeid", "type": "string" }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, { "description": "id of the availability zone", "name": "zoneid", "type": "string" }, - { - "description": "path of the Domain the snapshot's account belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "type of the datastore for the snapshot entry", - "name": "datastoretype", - "type": "string" - }, - {}, - { - "description": "name of the snapshot", - "name": "name", - "type": "string" - }, - { - "description": "the status of the template", - "name": "status", - "type": "string" - }, { "description": "name of the availability zone", "name": "zonename", "type": "string" - } - ] - }, - { - "description": "Delete the extensions", - "isasync": false, - "name": "deleteExtension", - "params": [ - { - "description": "ID of the extension", - "length": 255, - "name": "id", - "related": "listExtensions,deleteExtension,updateExtension,unregisterExtension", - "required": false, - "type": "uuid" }, { - "description": "Whether cleanup entry-point files for the extension", - "length": 255, - "name": "cleanup", - "related": "listExtensions,deleteExtension,updateExtension,unregisterExtension", - "required": false, + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" - } - ], - "related": "listExtensions,updateExtension,unregisterExtension", - "response": [ - { - "description": "Name of the extension", - "name": "name", - "type": "string" - }, - { - "description": "Removal timestamp of the extension, if applicable", - "name": "removed", - "type": "date" - }, - { - "description": "Description of the extension", - "name": "description", - "type": "string" }, - {}, { - "description": "ID of the extension", - "name": "id", + "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", + "description": "the type of the snapshot", + "name": "snapshottype", "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": "List of resources to which extension is registered to", - "name": "resources", - "response": [ - { - "description": "the details of the resource map", - "name": "details", - "type": "map" - }, - { - "description": "Name of the resource associated with this mapping", - "name": "name", - "type": "string" - }, - { - "description": "Type of the resource", - "name": "type", - "type": "string" - }, - { - "description": "Creation timestamp of the mapping", - "name": "created", - "type": "date" - }, - { - "description": "ID of the resource associated with the extension", - "name": "id", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "The details of the extension", - "name": "details", - "type": "map" - }, - { - "description": "The path of the entry point fo the extension", - "name": "path", + "description": "ID of the snapshot", + "name": "id", "type": "string" }, - {}, { - "description": "The state of the extension", - "name": "state", + "description": "path of the Domain the snapshot's account belongs to", + "name": "domainpath", "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", + "description": "ID of the datastore for the snapshot entry", + "name": "datastoreid", "type": "string" } - ], - "since": "4.21.0" + ] }, { "description": "migrates resources from one secondary storage to destination image store", @@ -104257,28 +104555,20 @@ "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", + "description": "id(s) of the templates to be migrated", "length": 255, - "name": "snapshots", - "related": "createSnapshotFromVMSnapshot,copySnapshot,archiveSnapshot,listSnapshots", + "name": "templates", + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", "required": false, "type": "list" }, { - "description": "id(s) of the templates to be migrated", + "description": "id of the destination secondary storage pool to which the resources are 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", - "required": false, - "type": "list" + "name": "destpool", + "related": "addSecondaryStorage,listSwifts,addImageStore", + "required": true, + "type": "uuid" }, { "description": "id of the image store from where the data is to be migrated", @@ -104287,21 +104577,19 @@ "related": "addSecondaryStorage,listSwifts,addImageStore", "required": true, "type": "uuid" + }, + { + "description": "id(s) of the snapshots to be migrated", + "length": 255, + "name": "snapshots", + "related": "createSnapshotFromVMSnapshot,copySnapshot,archiveSnapshot,listSnapshots", + "required": false, + "type": "list" } ], "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", @@ -104312,12 +104600,22 @@ "name": "migrationtype", "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": "Response message from migration of secondary storage data objects", + "name": "message", + "type": "string" + }, + {} ], "since": "4.19.0" }, @@ -104326,6 +104624,13 @@ "isasync": false, "name": "deleteSSHKeyPair", "params": [ + { + "description": "Name of the keypair", + "length": 255, + "name": "name", + "required": true, + "type": "string" + }, { "description": "the account associated with the keypair. Must be used with the domainId parameter.", "length": 255, @@ -104348,38 +104653,31 @@ "related": "createProject", "required": false, "type": "uuid" - }, - { - "description": "Name of the keypair", - "length": 255, - "name": "name", - "required": true, - "type": "string" } ], "response": [ {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, - {}, { "description": "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" - } + {} ] }, { @@ -104388,11 +104686,12 @@ "name": "searchLdap", "params": [ { - "description": "", + "description": "query to search using", "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "name": "query", + "related": "searchLdap", + "required": true, + "type": "string" }, { "description": "List by keyword", @@ -104402,17 +104701,16 @@ "type": "string" }, { - "description": "query to search using", + "description": "", "length": 255, - "name": "query", - "related": "searchLdap", - "required": true, - "type": "string" + "name": "page", + "required": false, + "type": "integer" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" } @@ -104421,14 +104719,9 @@ "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "The user's email", @@ -104445,12 +104738,17 @@ "name": "firstname", "type": "string" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The user's principle", + "name": "principal", + "type": "string" + }, + { + "description": "The user's domain", + "name": "domain", + "type": "string" }, - {}, { "description": "The user's username", "name": "username", @@ -104462,8 +104760,8 @@ "type": "string" }, { - "description": "The user's domain", - "name": "domain", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ], @@ -104486,57 +104784,57 @@ "related": "prepareForShutdown", "response": [ { - "description": "Indicates whether maintenance has been initiated", - "name": "maintenanceinitiated", - "type": "boolean" + "description": "The id of the management server", + "name": "managementserverid", + "type": "string" }, { - "description": "the state of the management server", - "name": "state", - "type": "state" + "description": "The host agents this management server is responsible for", + "name": "agents", + "type": "list" + }, + {}, + { + "description": "The number of jobs in progress", + "name": "pendingjobscount", + "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 state of the management server", + "name": "state", + "type": "state" + }, { "description": "Indicates whether a shutdown has been triggered", "name": "shutdowntriggered", "type": "boolean" }, { - "description": "Indicates whether CloudStack is ready to shutdown", - "name": "readyforshutdown", + "description": "Indicates whether maintenance has been initiated", + "name": "maintenanceinitiated", "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": "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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {} + } ], "since": "4.19.0" }, @@ -104569,21 +104867,21 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, - { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", - "type": "string" + "description": "list Tungsten-Fabric policy network name", + "name": "network", + "type": "list" }, { "description": "Tungsten-Fabric provider zone id", "name": "zoneid", "type": "long" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, {}, { "description": "Tungsten-Fabric logical router uuid", @@ -104596,9 +104894,9 @@ "type": "string" }, { - "description": "list Tungsten-Fabric policy network name", - "name": "network", - "type": "list" + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", + "type": "string" } ] }, @@ -104619,255 +104917,90 @@ "related": "listSharedFileSystems,stopSharedFileSystem,changeSharedFileSystemDiskOffering,changeSharedFileSystemServiceOffering", "response": [ { - "description": "ID of the storage fs vm", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "path to mount the shared filesystem", - "name": "path", - "type": "string" - }, - { - "description": "ID of the storage fs vm", - "name": "vmstate", - "type": "string" - }, - { - "description": "description of the shared filesystem", - "name": "description", - "type": "string" - }, - { - "description": "the state of the shared filesystem", - "name": "state", - "type": "string" - }, - { - "description": "ID of the storage pool hosting the data volume", - "name": "storageid", + "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": "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": "disk offering display text for the shared filesystem", - "name": "diskofferingdisplaytext", - "type": "string" - }, - { - "description": "ID of the shared filesystem", - "name": "id", - "type": "string" - }, { "description": "the shared filesystem's disk read in KiB", "name": "diskkbsread", "type": "long" }, { - "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": "Network name of the shared filesystem", - "name": "networkname", + "description": "ID of the storage fs vm", + "name": "vmstate", "type": "string" }, { - "description": "size of the shared filesystem", - "name": "size", - "type": "long" + "description": "the account associated with the shared filesystem", + "name": "account", + "type": "string" }, { - "description": "disk offering for the shared filesystem has custom size", - "name": "iscustomdiskoffering", - "type": "boolean" + "description": "name of the storage pool hosting the data volume", + "name": "storage", + "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", - "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": "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 isolation uri of the nic", - "name": "isolationuri", - "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", - "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": "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 traffic type of the nic", - "name": "traffictype", - "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 IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "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 name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "public IP address 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": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - } - ], - "type": "list" + "description": "ID of the storage fs data volume", + "name": "volumeid", + "type": "string" }, { - "description": "the ID of the domain associated with the shared filesystem", - "name": "domainid", + "description": "disk offering for the shared filesystem", + "name": "diskofferingname", "type": "string" }, + {}, { - "description": "the filesystem format", - "name": "filesystem", + "description": "the state of the shared filesystem", + "name": "state", "type": "string" }, { - "description": "service offering for the shared filesystem", - "name": "serviceofferingname", + "description": "name of the shared filesystem", + "name": "name", + "type": "string" + }, + { + "description": "size of the shared filesystem", + "name": "size", + "type": "long" + }, + { + "description": "provisioning type used in the shared filesystem", + "name": "provisioningtype", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the project ID of the shared filesystem", + "name": "projectid", + "type": "string" + }, + { + "description": "Network name of the shared filesystem", + "name": "networkname", "type": "string" }, { @@ -104875,48 +105008,48 @@ "name": "tags", "response": [ { - "description": "tag key name", - "name": "key", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the domain associated with the tag", + "name": "domain", "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" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -104925,64 +105058,67 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "set" }, { - "description": "name of the storage fs data volume", - "name": "volumename", - "type": "string" + "description": "the bytes allocated", + "name": "virtualsize", + "type": "long" }, { - "description": "path of the domain to which the shared filesystem", - "name": "domainpath", + "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": "Name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "the account associated with the shared filesystem", - "name": "account", + "description": "path to mount the shared filesystem", + "name": "path", "type": "string" }, - {}, { - "description": "the bytes allocated", - "name": "virtualsize", + "description": "the bytes actually consumed on disk", + "name": "physicalsize", "type": "long" }, + { + "description": "name of the storage fs data volume", + "name": "volumename", + "type": "string" + }, { "description": "Network ID of the shared filesystem", "name": "networkid", "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": "disk offering ID for the shared filesystem", - "name": "diskofferingid", + "description": "disk offering display text for the shared filesystem", + "name": "diskofferingdisplaytext", "type": "string" }, { - "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": "the filesystem format", + "name": "filesystem", + "type": "string" }, { "description": "the project name of the shared filesystem", @@ -104990,38 +105126,38 @@ "type": "string" }, { - "description": "size of the shared filesystem in GiB", - "name": "sizegb", + "description": "disk offering ID for the shared filesystem", + "name": "diskofferingid", "type": "string" }, { - "description": "provisioning type used in the shared filesystem", - "name": "provisioningtype", + "description": "description of the shared filesystem", + "name": "description", "type": "string" }, { - "description": "disk offering for the shared filesystem", - "name": "diskofferingname", + "description": "service offering for the shared filesystem", + "name": "serviceofferingname", "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 write (IO) of disk on the shared filesystem", - "name": "diskiowrite", - "type": "long" - }, { "description": "the disk utilization", "name": "utilization", "type": "string" }, { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "ID of the shared filesystem", + "name": "id", + "type": "string" + }, + { + "description": "the shared filesystem provider", + "name": "provider", "type": "string" }, { @@ -105030,29 +105166,191 @@ "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": "virtualmachineid", + "type": "string" }, { - "description": "name of the storage pool hosting the data volume", - "name": "storage", + "description": "the write (IO) of disk on the shared filesystem", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "path of the domain to which the shared filesystem", + "name": "domainpath", "type": "string" }, { - "description": "the project ID of the shared filesystem", - "name": "projectid", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "name of the shared filesystem", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the bytes actually consumed on disk", - "name": "physicalsize", - "type": "long" + "description": "the list of nics associated with the shared filesystem", + "name": "nic", + "response": [ + { + "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", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "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", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "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": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "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 ID of the nic", + "name": "id", + "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": "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 broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + } + ], + "type": "list" } ], "since": "4.20.0" @@ -105063,10 +105361,10 @@ "name": "createTungstenFabricFirewallRule", "params": [ { - "description": "Tungsten-Fabric firewall rule service group uuid", + "description": "Tungsten-Fabric firewall rule destination address group uuid", "length": 255, - "name": "servicegroupuuid", - "required": true, + "name": "destaddressgroupuuid", + "required": false, "type": "string" }, { @@ -105076,6 +105374,13 @@ "required": true, "type": "string" }, + { + "description": "Tungsten-Fabric firewall rule tag type uuid", + "length": 255, + "name": "tagtypeuuid", + "required": false, + "type": "string" + }, { "description": "the ID of zone", "length": 255, @@ -105085,23 +105390,9 @@ "type": "uuid" }, { - "description": "the uuid of Tungsten-Fabric firewall policy", - "length": 255, - "name": "firewallpolicyuuid", - "required": true, - "type": "string" - }, - { - "description": "the uuid of Tungsten-Fabric source network", - "length": 255, - "name": "srcnetworkuuid", - "required": false, - "type": "string" - }, - { - "description": "Tungsten-Fabric firewall rule destination address group uuid", + "description": "Tungsten-Fabric firewall rule destination tag uuid", "length": 255, - "name": "destaddressgroupuuid", + "name": "desttaguuid", "required": false, "type": "string" }, @@ -105112,6 +105403,13 @@ "required": true, "type": "integer" }, + { + "description": "Tungsten-Fabric firewall rule action", + "length": 255, + "name": "action", + "required": true, + "type": "string" + }, { "description": "Tungsten-Fabric firewall rule name", "length": 255, @@ -105120,10 +105418,10 @@ "type": "string" }, { - "description": "Tungsten-Fabric firewall rule action", + "description": "Tungsten-Fabric firewall rule source tag uuid", "length": 255, - "name": "action", - "required": true, + "name": "srctaguuid", + "required": false, "type": "string" }, { @@ -105134,10 +105432,10 @@ "type": "string" }, { - "description": "Tungsten-Fabric firewall rule tag type uuid", + "description": "the uuid of Tungsten-Fabric firewall policy", "length": 255, - "name": "tagtypeuuid", - "required": false, + "name": "firewallpolicyuuid", + "required": true, "type": "string" }, { @@ -105148,104 +105446,104 @@ "type": "string" }, { - "description": "Tungsten-Fabric firewall rule destination tag uuid", + "description": "Tungsten-Fabric firewall rule service group uuid", "length": 255, - "name": "desttaguuid", - "required": false, + "name": "servicegroupuuid", + "required": true, "type": "string" }, { - "description": "Tungsten-Fabric firewall rule source tag uuid", + "description": "the uuid of Tungsten-Fabric source network", "length": 255, - "name": "srctaguuid", + "name": "srcnetworkuuid", "required": false, "type": "string" } ], "related": "listTungstenFabricFirewallRule", "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 firewall rule name", - "name": "name", + "description": "Tungsten-Fabric firewall rule action", + "name": "action", "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 direction", + "name": "direction", "type": "string" }, { - "description": "Tungsten-Fabric firewall rule source address group", - "name": "srcaddressgroup", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "Tungsten-Fabric firewall rule source tag", - "name": "srctag", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, { - "description": "Tungsten-Fabric firewall rule destination tag", - "name": "desttag", + "description": "Tungsten-Fabric firewall rule service group", + "name": "servicegroup", "type": "string" }, { - "description": "Tungsten-Fabric firewall rule action", - "name": "action", + "description": "Tungsten-Fabric firewall rule tag type", + "name": "tagtype", "type": "string" }, { - "description": "Tungsten-Fabric firewall rule direction", - "name": "direction", + "description": "Tungsten-Fabric firewall rule uuid", + "name": "uuid", + "type": "string" + }, + { + "description": "Tungsten-Fabric firewall rule source tag", + "name": "srctag", + "type": "string" + }, + { + "description": "Tungsten-Fabric firewall rule destination network", + "name": "destnetwork", "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 address group", - "name": "destaddressgroup", + "description": "Tungsten-Fabric firewall rule name", + "name": "name", "type": "string" }, { - "description": "Tungsten-Fabric firewall rule uuid", - "name": "uuid", + "description": "Tungsten-Fabric firewall rule destination address group", + "name": "destaddressgroup", "type": "string" }, { - "description": "Tungsten-Fabric firewall rule service group", - "name": "servicegroup", + "description": "Tungsten-Fabric firewall rule source address group", + "name": "srcaddressgroup", "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 provider zone name", - "name": "zonename", - "type": "string" - } + {} ] }, { @@ -105254,49 +105552,40 @@ "name": "listConfigurations", "params": [ { - "description": "the ID of the Image Store to update the parameter value for corresponding image store", - "length": 255, - "name": "imagestoreuuid", - "related": "addSecondaryStorage,listSwifts,addImageStore", - "required": false, - "type": "uuid" - }, - { - "description": "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": "lists configuration by group name (primarily used for UI)", "length": 255, - "name": "subgroup", + "name": "group", "required": false, "since": "4.18.0", "type": "string" }, { - "description": "lists configuration by group name (primarily used for UI)", + "description": "the ID of the Domain to update the parameter value for corresponding domain", "length": 255, - "name": "group", + "name": "domainid", + "related": "createDomain,listDomains,listDomains", "required": false, - "since": "4.18.0", - "type": "string" + "type": "uuid" }, { - "description": "List by keyword", + "description": "lists configuration by name", "length": 255, - "name": "keyword", + "name": "name", "required": false, "type": "string" }, { - "description": "the ID of the Account to update the parameter value for corresponding account", + "description": "the ID of the Image Store to update the parameter value for corresponding image store", "length": 255, - "name": "accountid", - "related": "disableAccount,enableAccount,updateAccount,markDefaultZoneForAccount,listAccounts", + "name": "imagestoreuuid", + "related": "addSecondaryStorage,listSwifts,addImageStore", "required": false, "type": "uuid" }, @@ -105308,76 +105597,85 @@ "type": "string" }, { - "description": "lists configuration by name", + "description": "the ID of the Cluster to update the parameter value for corresponding cluster", "length": 255, - "name": "name", + "name": "clusterid", + "related": "addCluster,updateCluster", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the ID of the Zone to update the parameter value for corresponding zone", + "description": "the ID of the Storage pool to update the parameter value for corresponding storage pool", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", "required": false, "type": "uuid" }, { - "description": "the ID of the Cluster to update the parameter value for corresponding cluster", + "description": "the ID of the Account to update the parameter value for corresponding account", "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", + "name": "accountid", + "related": "disableAccount,enableAccount,updateAccount,markDefaultZoneForAccount,listAccounts", "required": false, "type": "uuid" }, + { + "description": "lists configuration by parent name (primarily used for UI)", + "length": 255, + "name": "parent", + "required": false, + "since": "4.18.0", + "type": "string" + }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "the ID of the Domain to update the parameter value for corresponding domain", + "description": "", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "the ID of the Storage pool to update the parameter value for corresponding storage pool", + "description": "the ID of the Zone to update the parameter value for corresponding zone", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", + "name": "zoneid", + "related": "listZones", "required": false, "type": "uuid" }, { - "description": "", + "description": "lists configuration by subgroup name (primarily used for UI)", "length": 255, - "name": "page", + "name": "subgroup", "required": false, - "type": "integer" + "since": "4.18.0", + "type": "string" } ], "related": "", "response": [ { "description": "the value of the configuration", - "name": "value", - "type": "string" - }, - { - "description": "true if the configuration is dynamic", - "name": "isdynamic", - "type": "boolean" + "name": "id", + "type": "long" }, { "description": "scope(zone/cluster/pool/account) of the parameter that needs to be updated", "name": "scope", "type": "string" }, + { + "description": "the type of the configuration value", + "name": "type", + "type": "string" + }, { "description": "the possible options of the configuration value", "name": "options", @@ -105389,8 +105687,13 @@ "type": "string" }, { - "description": "the default value of the configuration", - "name": "defaultvalue", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the category of the configuration", + "name": "category", "type": "string" }, { @@ -105403,35 +105706,31 @@ "name": "component", "type": "string" }, + {}, { "description": "the value of the configuration", - "name": "id", - "type": "long" - }, - { - "description": "the category of the configuration", - "name": "category", + "name": "value", "type": "string" }, + {}, { "description": "the name of the configuration", "name": "name", "type": "string" }, { - "description": "the display text of the configuration", - "name": "displaytext", + "description": "the name of the parent configuration", + "name": "parent", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if the configuration is dynamic", + "name": "isdynamic", + "type": "boolean" }, { - "description": "the type of the configuration value", - "name": "type", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -105440,16 +105739,15 @@ "type": "string" }, { - "description": "the name of the parent configuration", - "name": "parent", + "description": "the default value of the configuration", + "name": "defaultvalue", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the display text of the configuration", + "name": "displaytext", "type": "string" - }, - {} + } ] }, { @@ -105457,6 +105755,14 @@ "isasync": true, "name": "scaleKubernetesCluster", "params": [ + { + "description": "the ID of the Kubernetes cluster", + "length": 255, + "name": "id", + "related": "createKubernetesCluster,startKubernetesCluster,scaleKubernetesCluster", + "required": true, + "type": "uuid" + }, { "description": "number of Kubernetes cluster nodes", "length": 255, @@ -105465,27 +105771,20 @@ "type": "long" }, { - "description": "the ID of the service offering for the virtual machines in the cluster.", + "description": "the IDs of the nodes to be removed", "length": 255, - "name": "serviceofferingid", - "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", + "name": "nodeids", + "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,createVMFromBackup,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "required": false, - "type": "uuid" - }, - { - "description": "the ID of the Kubernetes cluster", - "length": 255, - "name": "id", - "related": "createKubernetesCluster,startKubernetesCluster,scaleKubernetesCluster", - "required": true, - "type": "uuid" + "type": "list" }, { - "description": "Minimum number of worker nodes in the cluster", + "description": "(Optional) Node Type to Service Offering ID mapping. If provided, it overrides the serviceofferingid parameter", "length": 255, - "name": "minsize", + "name": "nodeofferings", "required": false, - "type": "long" + "since": "4.21.0", + "type": "map" }, { "description": "Maximum number of worker nodes in the cluster", @@ -105495,20 +105794,19 @@ "type": "long" }, { - "description": "(Optional) Node Type to Service Offering ID mapping. If provided, it overrides the serviceofferingid parameter", + "description": "the ID of the service offering for the virtual machines in the cluster.", "length": 255, - "name": "nodeofferings", + "name": "serviceofferingid", + "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", "required": false, - "since": "4.21.0", - "type": "map" + "type": "uuid" }, { - "description": "the IDs of the nodes to be removed", + "description": "Minimum number of worker nodes in the cluster", "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", + "name": "minsize", "required": false, - "type": "list" + "type": "long" }, { "description": "Whether autoscaling is enabled for the cluster", @@ -105521,29 +105819,24 @@ "related": "createKubernetesCluster,startKubernetesCluster", "response": [ { - "description": "the ID of the service offering of the control nodes on the Kubernetes cluster", - "name": "controlofferingid", - "type": "string" - }, - { - "description": "the ID of the domain in which the Kubernetes cluster exists", - "name": "domainid", + "description": "the ID of the template of the Kubernetes cluster", + "name": "templateid", "type": "string" }, { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zonename", - "type": "string" + "description": "the list of virtualmachine associated with this Kubernetes cluster", + "name": "virtualmachines", + "type": "list" }, { - "description": "the name of the service offering of the control nodes on the Kubernetes cluster", - "name": "controlofferingname", + "description": "the name of the domain in which the Kubernetes cluster exists", + "name": "domain", "type": "string" }, { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zoneid", - "type": "string" + "description": "the control nodes count for the Kubernetes cluster", + "name": "controlnodes", + "type": "long" }, { "description": "the type of the cluster", @@ -105551,59 +105844,54 @@ "type": "clustertype" }, { - "description": "path of the domain to which the Kubernetes cluster belongs", - "name": "domainpath", + "description": "the ID of the service offering of the worker nodes on the Kubernetes cluster", + "name": "workerofferingid", "type": "string" }, { - "description": "the project id of the Kubernetes cluster", - "name": "projectid", - "type": "string" + "description": "Maximum size of the cluster", + "name": "maxsize", + "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project name of the Kubernetes cluster", + "name": "project", "type": "string" }, { - "description": "the size (worker nodes count) of the Kubernetes cluster", - "name": "size", - "type": "long" - }, - { - "description": "the 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 domain in which the Kubernetes cluster exists", + "name": "domainid", "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": "the memory the Kubernetes cluster", - "name": "memory", + "description": "Public IP Address of the cluster", + "name": "ipaddress", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Name of CNI Configuration associated with the cluster", + "name": "cniconfigname", + "type": "string" }, { - "description": "the description of the Kubernetes cluster", - "name": "description", + "description": "keypair details", + "name": "keypair", "type": "string" }, { - "description": "URL end point for the Kubernetes cluster dashboard UI", - "name": "consoleendpoint", + "description": "the name of the service offering of the control nodes on the Kubernetes cluster", + "name": "controlofferingname", "type": "string" }, { @@ -105611,14 +105899,20 @@ "name": "etcdips", "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", + "description": "the name of the zone of the Kubernetes cluster", + "name": "zoneid", + "type": "string" + }, + { + "description": "the cpu cores of the Kubernetes cluster", + "name": "cpunumber", "type": "string" }, { @@ -105627,83 +105921,88 @@ "type": "string" }, { - "description": "the name of the service offering of the Kubernetes cluster", - "name": "serviceofferingname", + "description": "the name of the service offering of the etcd nodes on the Kubernetes cluster", + "name": "etcdofferingname", "type": "string" }, { - "description": "the ID of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the name of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionname", + "description": "the ID of the service offering of the Kubernetes cluster", + "name": "serviceofferingid", "type": "string" }, { - "description": "the cpu cores of the Kubernetes cluster", - "name": "cpunumber", + "description": "the account associated with the Kubernetes cluster", + "name": "account", "type": "string" }, { - "description": "Public IP Address of the cluster", - "name": "ipaddress", + "description": "URL end point for the Kubernetes cluster dashboard UI", + "name": "consoleendpoint", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "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": "Public IP Address ID of the cluster", + "name": "ipaddressid", + "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 Kubernetes cluster", + "name": "serviceofferingname", "type": "string" }, { - "description": "URL end point for the Kubernetes cluster", - "name": "endpoint", + "description": "the name of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionname", "type": "string" }, { - "description": "Maximum size of the cluster", - "name": "maxsize", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the name of the Kubernetes cluster", - "name": "name", - "type": "string" + "description": "Indicates if the CloudStack CSI driver has been setup in the cluster", + "name": "csienabled", + "type": "boolean" }, { - "description": "the project name of the Kubernetes cluster", - "name": "project", + "description": "Minimum size of the cluster", + "name": "minsize", + "type": "long" + }, + { + "description": "the name of the network of the Kubernetes cluster", + "name": "associatednetworkname", "type": "string" }, { - "description": "the control nodes count for the Kubernetes cluster", - "name": "controlnodes", - "type": "long" + "description": "the ID of the service offering of the etcd nodes on the Kubernetes cluster", + "name": "etcdofferingid", + "type": "string" }, { - "description": "the ID of the service offering of the Kubernetes cluster", - "name": "serviceofferingid", + "description": "the ID of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionid", "type": "string" }, { - "description": "the ID of the network of the Kubernetes cluster", - "name": "networkid", + "description": "ID of CNI Configuration associated with the cluster", + "name": "cniconfigurationid", "type": "string" }, { - "description": "Name of CNI Configuration associated with the cluster", - "name": "cniconfigname", + "description": "path of the domain to which the Kubernetes cluster belongs", + "name": "domainpath", "type": "string" }, { @@ -105712,55 +106011,59 @@ "type": "long" }, { - "description": "Public IP Address ID of the cluster", - "name": "ipaddressid", + "description": "URL end point for the Kubernetes cluster", + "name": "endpoint", "type": "string" }, - {}, { - "description": "the ID of the template of the Kubernetes cluster", - "name": "templateid", - "type": "string" + "description": "the size (worker nodes count) of the Kubernetes cluster", + "name": "size", + "type": "long" }, { - "description": "the id of the Kubernetes cluster", - "name": "id", + "description": "the state of the Kubernetes cluster", + "name": "state", "type": "string" }, { - "description": "Minimum size of the cluster", - "name": "minsize", - "type": "long" + "description": "the description of the Kubernetes cluster", + "name": "description", + "type": "string" }, { - "description": "Whether autoscaling is enabled for the cluster", - "name": "autoscalingenabled", - "type": "boolean" + "description": "the ID of the service offering of the control nodes on the Kubernetes cluster", + "name": "controlofferingid", + "type": "string" }, { - "description": "the date when this Kubernetes cluster was created", - "name": "created", - "type": "date" + "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 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 etcd nodes on the Kubernetes cluster", - "name": "etcdofferingid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the state of the Kubernetes cluster", - "name": "state", + "description": "Whether autoscaling is enabled for the cluster", + "name": "autoscalingenabled", + "type": "boolean" + }, + { + "description": "the project id of the Kubernetes cluster", + "name": "projectid", "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 date when this Kubernetes cluster was created", + "name": "created", + "type": "date" } ] }, @@ -105769,6 +106072,13 @@ "isasync": true, "name": "stopNetScalerVpx", "params": [ + { + "description": "Force stop the VM (vm is marked as Stopped even when command fails to be send to the backend, otherwise a force poweroff is attempted). To be used if the caller knows the VM is stopped and should be marked as such.", + "length": 255, + "name": "forced", + "required": false, + "type": "boolean" + }, { "description": "the ID of the NetScaler vm", "length": 255, @@ -105776,36 +106086,43 @@ "related": "listRouters,rebootRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", "required": true, "type": "uuid" - }, - { - "description": "Force stop the VM (vm is marked as Stopped even when command fails to be send to the backend, otherwise a force poweroff is attempted). To be used if the caller knows the VM is stopped and should be marked as such.", - "length": 255, - "name": "forced", - "required": false, - "type": "boolean" } ], "related": "listRouters,rebootRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs", "response": [ - {}, { "description": "the network domain for the router", "name": "networkdomain", "type": "string" }, { - "description": "the domain associated with the router", - "name": "domain", + "description": "the hostname for the router", + "name": "hostname", "type": "string" }, { - "description": "the template ID for the router", - "name": "templateid", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the domain ID associated with the router", - "name": "domainid", + "description": "the second DNS for the router", + "name": "dns2", + "type": "string" + }, + { + "description": "the public netmask for the router", + "name": "publicnetmask", + "type": "string" + }, + { + "description": "the version of the code / software in the router", + "name": "softwareversion", + "type": "string" + }, + { + "description": "the project name of the address", + "name": "project", "type": "string" }, { @@ -105814,18 +106131,53 @@ "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 gateway for the router", - "name": "gateway", + "description": "the control state of the host for the router", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the public IP address for the router", - "name": "publicip", + "description": "the Zone name for the router", + "name": "zonename", + "type": "string" + }, + { + "description": "path of the Domain the router belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the state of redundant virtual router", + "name": "redundantstate", + "type": "string" + }, + { + "description": "the id of the router", + "name": "id", + "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 name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { @@ -105839,53 +106191,74 @@ "type": "string" }, { - "description": "the control state of the host for the router", - "name": "hostcontrolstate", + "description": "the link local MAC address for the router", + "name": "linklocalmacaddress", "type": "string" }, { - "description": "the Pod ID for the router", - "name": "podid", + "description": "the name of VPC the router belongs to", + "name": "vpcname", "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 Pod name for the router", - "name": "podname", + "description": "true if the router template requires upgrader", + "name": "requiresupgrade", + "type": "boolean" + }, + { + "description": "the state of the router", + "name": "state", + "type": "state" + }, + { + "description": "the Pod ID for the router", + "name": "podid", "type": "string" }, { - "description": "the link local MAC address for the router", - "name": "linklocalmacaddress", + "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 for the router", + "name": "publicip", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the template name for the router", + "name": "templatename", "type": "string" }, + {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the name of the router", + "name": "name", + "type": "string" }, { - "description": "path of the Domain the router belongs to", - "name": "domainpath", + "description": "the Pod name for the router", + "name": "podname", "type": "string" }, { - "description": "the Zone name for the router", - "name": "zonename", + "description": "the ID of the corresponding public network", + "name": "publicnetworkid", "type": "string" }, { - "description": "VPC the router belongs to", - "name": "vpcid", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { @@ -105893,73 +106266,78 @@ "name": "nic", "response": [ { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" }, { - "description": "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": "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 broadcast uri of the nic", - "name": "broadcasturi", + "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": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "the ID of the corresponding network", + "name": "networkid", + "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 isolation uri of the nic", - "name": "isolationuri", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { @@ -105968,23 +106346,23 @@ "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 cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { @@ -105993,121 +106371,66 @@ "type": "list" }, { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "Id of the 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": "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": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "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": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the gateway of the nic", + "name": "gateway", "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" } ], "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", + "description": "the link local IP address for the router", + "name": "linklocalip", "type": "string" }, { - "description": "the guest netmask for the router", - "name": "guestnetmask", + "description": "the version of scripts", + "name": "scriptsversion", "type": "string" }, { @@ -106115,66 +106438,30 @@ "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", + "description": "the name of the health check on the router", + "name": "checkname", "type": "string" }, { - "description": "result of the health check", + "description": "the result of the health check in enum form: {SUCCESS, FAILURE, WARNING, UNKNOWN}", + "name": "status", + "type": "routerhealthstatus" + }, + { + "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 type of the health check - basic or advanced", "name": "checktype", @@ -106184,24 +106471,34 @@ "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" } ], "type": "list" }, { - "description": "the template name for the router", - "name": "templatename", + "description": "VPC the router belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the state of the router", - "name": "state", - "type": "state" + "description": "true if any health checks had failed", + "name": "healthchecksfailed", + "type": "boolean" + }, + { + "description": "role of the domain router", + "name": "role", + "type": "string" + }, + { + "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 ID of the corresponding link local network", @@ -106209,8 +106506,18 @@ "type": "string" }, { - "description": "the public MAC address for the router", - "name": "publicmacaddress", + "description": "the name of the corresponding guest network", + "name": "guestnetworkname", + "type": "string" + }, + { + "description": "the second IPv6 DNS for the router", + "name": "ip6dns2", + "type": "string" + }, + { + "description": "the host ID for the router", + "name": "hostid", "type": "string" }, { @@ -106219,44 +106526,45 @@ "type": "boolean" }, { - "description": "the second DNS for the router", - "name": "dns2", + "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", + "description": "the gateway for the router", + "name": "gateway", "type": "string" }, { - "description": "true if the router template requires upgrader", - "name": "requiresupgrade", - "type": "boolean" + "description": "the domain associated with the router", + "name": "domain", + "type": "string" }, { - "description": "the name of VPC the router belongs to", - "name": "vpcname", + "description": "the domain ID associated with the router", + "name": "domainid", "type": "string" }, { - "description": "the id of the router", - "name": "id", + "description": "the ID of the corresponding guest network", + "name": "guestnetworkid", "type": "string" }, { - "description": "the version of scripts", - "name": "scriptsversion", + "description": "the version of template", + "name": "version", "type": "string" }, { - "description": "the state of redundant virtual router", - "name": "redundantstate", + "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 account associated with the router", + "name": "account", + "type": "string" } ] }, @@ -106275,28 +106583,28 @@ } ], "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" }, + {}, { "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" - }, - {} + } ] }, { @@ -106312,18 +106620,19 @@ "type": "string" }, { - "description": "The network name label of the physical device dedicated to this traffic on a VMware host", + "description": "The network name label of the physical device dedicated to this traffic on a KVM host", "length": 255, - "name": "vmwarenetworklabel", + "name": "kvmnetworklabel", "required": false, "type": "string" }, { - "description": "The network name of the physical device dedicated to this traffic on an OVM3 host", + "description": "traffic type id", "length": 255, - "name": "ovm3networklabel", - "required": false, - "type": "string" + "name": "id", + "related": "addTrafficType,listTrafficTypes,updateTrafficType", + "required": true, + "type": "uuid" }, { "description": "The network name label of the physical device dedicated to this traffic on a XenServer host", @@ -106333,27 +106642,25 @@ "type": "string" }, { - "description": "The network name label of the physical device dedicated to this traffic on a KVM host", + "description": "The network name of the physical device dedicated to this traffic on an OVM3 host", "length": 255, - "name": "kvmnetworklabel", + "name": "ovm3networklabel", "required": false, "type": "string" }, { - "description": "traffic type id", + "description": "The network name label of the physical device dedicated to this traffic on a VMware host", "length": 255, - "name": "id", - "related": "addTrafficType,updateTrafficType", - "required": true, - "type": "uuid" + "name": "vmwarenetworklabel", + "required": false, + "type": "string" } ], - "related": "addTrafficType", + "related": "addTrafficType,listTrafficTypes", "response": [ - {}, { - "description": "id of the network provider", - "name": "id", + "description": "The network name label of the physical device dedicated to this traffic on a HyperV host", + "name": "hypervnetworklabel", "type": "string" }, { @@ -106362,8 +106669,8 @@ "type": "string" }, { - "description": "the trafficType to be added to the physical network", - "name": "traffictype", + "description": "id of the network provider", + "name": "id", "type": "string" }, { @@ -106371,20 +106678,25 @@ "name": "vmwarenetworklabel", "type": "string" }, - {}, { - "description": "The network name label of the physical device dedicated to this traffic on a HyperV host", - "name": "hypervnetworklabel", + "description": "The network name label of the physical device dedicated to this traffic on a KVM host", + "name": "kvmnetworklabel", "type": "string" }, + {}, { - "description": "The network name label of the physical device dedicated to this traffic on a XenServer host", - "name": "xennetworklabel", + "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 KVM host", - "name": "kvmnetworklabel", + "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 XenServer host", + "name": "xennetworklabel", "type": "string" }, { @@ -106393,15 +106705,11 @@ "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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } + {} ], "since": "3.0.0" }, @@ -106411,40 +106719,38 @@ "name": "listConditions", "params": [ { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "List by keyword", "length": 255, - "name": "projectid", - "related": "createProject", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "", "length": 255, - "name": "isrecursive", + "name": "page", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "list only resources belonging to the domain specified", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains", + "name": "isrecursive", "required": false, - "type": "uuid" + "type": "boolean" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "the ID of the policy", + "description": "ID of the Condition.", "length": 255, - "name": "policyid", - "related": "listAutoScalePolicies", + "name": "id", + "related": "listConditions", "required": false, "type": "uuid" }, @@ -106456,120 +106762,122 @@ "type": "boolean" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "Counter-id of the condition.", "length": 255, - "name": "account", + "name": "counterid", + "related": "createCounter", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "List by keyword", + "description": "the ID of the policy", "length": 255, - "name": "keyword", + "name": "policyid", + "related": "listAutoScalePolicies", "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": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "counterid", - "related": "createCounter", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "ID of the Condition.", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "id", - "related": "listConditions", + "name": "projectid", + "related": "createProject", "required": false, "type": "uuid" } ], "related": "", "response": [ + { + "description": "path of the domain to which the Condition owner belongs", + "name": "domainpath", + "type": "string" + }, + {}, { "description": "Threshold Value for the counter.", "name": "threshold", "type": "long" }, { - "description": "the project name of the Condition", - "name": "project", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the project id of the Condition.", - "name": "projectid", + "description": "the domain name of the owner.", + "name": "domain", "type": "string" }, - {}, { - "description": "the domain id of the Condition owner", - "name": "domainid", + "description": "Relational Operator to be used with threshold.", + "name": "relationaloperator", "type": "string" }, { - "description": "Details of the Counter.", - "name": "counter", - "type": "counterresponse" - }, - { - "description": "the owner of the Condition.", - "name": "account", + "description": "the project id of the Condition.", + "name": "projectid", "type": "string" }, - {}, { "description": "the Id of the Counter.", "name": "counterid", "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" }, { - "description": "Relational Operator to be used with threshold.", - "name": "relationaloperator", + "description": "zone id of counter", + "name": "zoneid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the id of the Condition", + "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 Condition", - "name": "id", + "description": "the domain id of the Condition owner", + "name": "domainid", "type": "string" }, + {}, { "description": "the Name of the Counter.", "name": "countername", "type": "string" }, { - "description": "the domain name of the owner.", - "name": "domain", + "description": "Details of the Counter.", + "name": "counter", + "type": "counterresponse" + }, + { + "description": "the owner of the Condition.", + "name": "account", "type": "string" }, { - "description": "path of the domain to which the Condition owner belongs", - "name": "domainpath", + "description": "the project name of the Condition", + "name": "project", "type": "string" } ] @@ -106580,9 +106888,9 @@ "name": "addBackupRepository", "params": [ { - "description": "address of the backup repository", + "description": "type of the backup repository storage. Supported values: nfs, cephfs, cifs", "length": 255, - "name": "address", + "name": "type", "required": true, "type": "string" }, @@ -106593,13 +106901,6 @@ "required": false, "type": "string" }, - { - "description": "shared storage mount options", - "length": 255, - "name": "mountopts", - "required": false, - "type": "string" - }, { "description": "capacity of this backup repository", "length": 255, @@ -106608,14 +106909,14 @@ "type": "long" }, { - "description": "type of the backup repository storage. Supported values: nfs, cephfs, cifs", + "description": "shared storage mount options", "length": 255, - "name": "type", - "required": true, + "name": "mountopts", + "required": false, "type": "string" }, { - "description": "ID of the zone where the backup repository is to be added", + "description": "ID of the zone where the backup repository is to be added for taking backups", "length": 255, "name": "zoneid", "related": "listZones", @@ -106628,35 +106929,35 @@ "name": "name", "required": true, "type": "string" + }, + { + "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, + "name": "address", + "required": true, + "type": "string" } ], "related": "", "response": [ { - "description": "the Zone ID of the backup repository", - "name": "zoneid", + "description": "the address / url of the backup repository", + "name": "address", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "capacity of the backup repository", - "name": "capacitybytes", - "type": "long" - }, { "description": "backup type", "name": "type", "type": "string" }, - { - "description": "the address / url of the backup repository", - "name": "address", - "type": "string" - }, { "description": "the name of the backup repository", "name": "name", @@ -106667,28 +106968,48 @@ "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 backup repository", "name": "id", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "capacity of the backup repository", + "name": "capacitybytes", + "type": "long" }, { "description": "the date and time the backup repository was added", "name": "created", "type": "date" }, - {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the backups in this repository can be used to create Instances on all Zones", + "name": "crosszoneinstancecreation", + "type": "boolean" + }, {}, { "description": "name of the provider", "name": "provider", "type": "string" - } + }, + { + "description": "the Zone ID of the backup repository", + "name": "zoneid", + "type": "string" + }, + {} ], "since": "4.20.0" }, @@ -106729,27 +107050,27 @@ "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", + "description": "Type of migration requested for", + "name": "migrationtype", "type": "string" - }, - {} + } ], "since": "4.15.0" }, @@ -106770,32 +107091,17 @@ "description": "The ID of the volume", "length": 255, "name": "id", - "related": "createVolume,updateVolume,listVolumes,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", + "related": "importVolume,createVolume,updateVolume,listVolumes,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", "required": true, "type": "uuid" } ], - "related": "createVolume,updateVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", + "related": "importVolume,createVolume,updateVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", "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": "type of the disk volume (ROOT or DATADISK)", - "name": "type", - "type": "string" + "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", + "name": "deviceid", + "type": "long" }, { "description": "the name of the ISO attached to the virtual machine", @@ -106803,54 +107109,90 @@ "type": "string" }, { - "description": "details for the volume check result, they may vary for different hypervisors", - "name": "volumecheckresult", - "type": "map" - }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", - "type": "string" - }, - { - "description": "state of the virtual machine", - "name": "vmstate", - "type": "string" - }, - { - "description": "ID of the disk volume", - "name": "id", - "type": "string" + "description": "the list of resource tags associated", + "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": "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": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the 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": "type of the virtual machine", - "name": "vmtype", + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", "type": "boolean" }, { - "description": "the format of the disk encryption if applicable", - "name": "encryptformat", - "type": "string" + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", + "type": "long" }, { - "description": "true if volume has delete protection.", - "name": "deleteprotection", - "type": "boolean" + "description": "name of the disk offering", + "name": "diskofferingname", + "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { @@ -106858,30 +107200,19 @@ "name": "storagetype", "type": "string" }, - {}, - { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", "type": "long" }, { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" - }, - { - "description": "size of the disk volume", - "name": "size", - "type": "long" + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" }, { - "description": "the disk utilization", - "name": "utilization", + "description": "the format of the disk encryption if applicable", + "name": "encryptformat", "type": "string" }, { @@ -106890,104 +107221,110 @@ "type": "long" }, { - "description": "the account associated with the disk volume", - "name": "account", + "description": "type of the virtual machine", + "name": "vmtype", "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": "ID of the availability zone", - "name": "zoneid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + { + "description": "the bytes actually consumed on disk", + "name": "physicalsize", + "type": "long" + }, { "description": "the state of the disk volume", "name": "state", "type": "string" }, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", + "description": "the project name of the vpn", + "name": "project", + "type": "string" + }, + { + "description": "name of the virtual machine", + "name": "vmname", "type": "string" }, + {}, { "description": "true if the entity/resource has annotations", "name": "hasannotations", "type": "boolean" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "path of the Domain the disk volume belongs to", + "name": "domainpath", "type": "string" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", + "description": "cluster name where the volume is allocated", + "name": "clustername", "type": "string" }, { - "description": "the bytes allocated", - "name": "virtualsize", - "type": "long" - }, - { - "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": "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": "cluster name where the volume is allocated", - "name": "clustername", + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", "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": "name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", - "type": "string" + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", + "type": "boolean" }, { - "description": "max iops of the disk volume", - "name": "maxiops", - "type": "long" + "description": "name of the service offering for root disk", + "name": "serviceofferingname", + "type": "string" }, { - "description": "the status of the volume", - "name": "status", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", - "name": "deviceid", - "type": "long" + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", + "type": "boolean" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the chain info of the volume", + "name": "chaininfo", "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", @@ -106995,29 +107332,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", - "type": "string" - }, - { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "type": "string" }, { - "description": "pod id of the volume", - "name": "podid", + "description": "id of the virtual machine", + "name": "virtualmachineid", "type": "string" }, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" + "description": "the date the disk volume was created", + "name": "created", + "type": "date" }, { "description": "pod name of the volume", @@ -107025,155 +107357,119 @@ "type": "string" }, { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", - "type": "string" - }, - { - "description": "the project id of the vpn", - "name": "projectid", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { - "description": "the path of the volume", - "name": "path", - "type": "string" - }, - { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", - "type": "string" - }, - { - "description": "details for the volume repair result, they may vary for different hypervisors", - "name": "volumerepairresult", - "type": "map" - }, - { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "description": "ID of the disk volume", + "name": "id", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the 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": "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": "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" - } - ], - "type": "set" + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", + "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" }, { - "description": "path of the Domain the disk volume belongs to", - "name": "domainpath", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" + }, + { + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "pod id of the volume", + "name": "podid", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the bytes allocated", + "name": "virtualsize", + "type": "long" + }, + { + "description": "state of the virtual machine", + "name": "vmstate", "type": "string" }, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" + }, + { + "description": "the status of the volume", + "name": "status", "type": "string" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", + "description": "display name of the virtual machine", + "name": "vmdisplayname", + "type": "string" + }, + { + "description": "max iops of the disk volume", + "name": "maxiops", "type": "long" }, { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", "type": "long" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + {}, + { + "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": "the disk utilization", + "name": "utilization", + "type": "string" + }, + { + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", + "type": "string" + }, + { + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { @@ -107182,23 +107478,48 @@ "type": "string" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "description": "size of the disk volume", + "name": "size", + "type": "long" + }, + { + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", - "type": "boolean" + "description": "cluster id of the volume", + "name": "clusterid", + "type": "string" }, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "the path of the volume", + "name": "path", "type": "string" }, { - "description": "the chain info of the volume", - "name": "chaininfo", + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "type": "long" + }, + { + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", + "type": "string" + }, + { + "description": "name of the availability zone", + "name": "zonename", + "type": "string" + }, + { + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", + "type": "string" + }, + { + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", "type": "string" } ], @@ -107210,16 +107531,9 @@ "name": "addTrafficType", "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", + "description": "The VLAN id to be used for Management traffic by VMware host", "length": 255, - "name": "vmwarenetworklabel", + "name": "vlan", "required": false, "type": "string" }, @@ -107231,33 +107545,26 @@ "type": "string" }, { - "description": "The VLAN id to be used for Management traffic by VMware host", + "description": "the trafficType to be added to the physical network", "length": 255, - "name": "vlan", - "required": false, + "name": "traffictype", + "required": true, "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 Hyperv host", "length": 255, - "name": "kvmnetworklabel", + "name": "hypervnetworklabel", "required": false, "type": "string" }, { - "description": "The network name label of the physical device dedicated to this traffic on a XenServer host", + "description": "The network name label of the physical device dedicated to this traffic on a VMware host", "length": 255, - "name": "xennetworklabel", + "name": "vmwarenetworklabel", "required": false, "type": "string" }, - { - "description": "the trafficType to be added to the physical network", - "length": 255, - "name": "traffictype", - "required": true, - "type": "string" - }, { "description": "the Physical Network ID", "length": 255, @@ -107272,18 +107579,38 @@ "name": "isolationmethod", "required": false, "type": "string" + }, + { + "description": "The network name label of the physical device dedicated to this traffic on a KVM host", + "length": 255, + "name": "kvmnetworklabel", + "required": false, + "type": "string" + }, + { + "description": "The network name label of the physical device dedicated to this traffic on a XenServer host", + "length": 255, + "name": "xennetworklabel", + "required": false, + "type": "string" } ], - "related": "", + "related": "listTrafficTypes", "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 XenServer host", + "name": "xennetworklabel", "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 network name label of the physical device dedicated to this traffic on a KVM host", + "name": "kvmnetworklabel", "type": "string" }, { @@ -107293,8 +107620,8 @@ }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "id of the network provider", + "name": "id", "type": "string" }, { @@ -107303,29 +107630,23 @@ "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 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", - "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 XenServer host", - "name": "xennetworklabel", + "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 physical network this belongs to", + "name": "physicalnetworkid", "type": "string" } ], @@ -107351,13 +107672,6 @@ "required": false, "type": "string" }, - { - "description": "Whether to filter the selectors by type and, if so, which one. Valid options are: ISO, SNAPSHOT, TEMPLATE and VOLUME.", - "length": 255, - "name": "type", - "required": false, - "type": "string" - }, { "description": "", "length": 255, @@ -107378,40 +107692,36 @@ "name": "showremoved", "required": false, "type": "boolean" + }, + { + "description": "Whether to filter the selectors by type and, if so, which one. Valid options are: ISO, SNAPSHOT, TEMPLATE and VOLUME.", + "length": 255, + "name": "type", + "required": false, + "type": "string" } ], "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", - "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 resource type directed to a specific secondary storage by the selector. Valid options are: ISO, SNAPSHOT, TEMPLATE and VOLUME.", + "name": "type", "type": "string" }, - {}, { - "description": "Description of the heuristic.", - "name": "description", + "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": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "Name of the heuristic.", @@ -107419,20 +107729,31 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Description of the heuristic.", + "name": "description", + "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" }, + { + "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": "When the heuristic was created.", + "name": "created", + "type": "date" } ], "since": "4.19.0" @@ -107443,11 +107764,11 @@ "name": "listLoadBalancerRuleInstances", "params": [ { - "description": "", + "description": "true if listing all virtual machines currently applied to the load balancer rule; default is true", "length": 255, - "name": "pagesize", + "name": "applied", "required": false, - "type": "integer" + "type": "boolean" }, { "description": "the ID of the load balancer rule", @@ -107458,16 +107779,16 @@ "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", + "description": "true if load balancer rule VM IP information to be included; default is false", "length": 255, - "name": "applied", + "name": "lbvmips", "required": false, "type": "boolean" }, @@ -107479,37 +107800,37 @@ "type": "integer" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" } ], "related": "listLoadBalancerRuleInstances", "response": [ - { - "description": "IP addresses of the vm set of lb rule", - "name": "lbvmipaddresses", - "type": "list" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, + { + "description": "IP addresses of the vm set of lb rule", + "name": "lbvmipaddresses", + "type": "list" + }, { "description": "the user vm set for lb rule", "name": "loadbalancerruleinstance", "type": "uservmresponse" - }, - {} + } ] }, { @@ -107527,6 +107848,7 @@ } ], "response": [ + {}, {}, { "description": "the UUID of the latest async job acting on this object", @@ -107543,7 +107865,6 @@ "name": "success", "type": "boolean" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -107564,18 +107885,11 @@ "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", + "description": "Tag the physical network", "length": 255, - "name": "vlan", + "name": "tags", "required": false, - "type": "string" + "type": "list" }, { "description": "physical network id", @@ -107586,11 +107900,18 @@ "type": "uuid" }, { - "description": "Tag the physical network", + "description": "the speed for the physical network[1G/10G]", "length": 255, - "name": "tags", + "name": "networkspeed", "required": false, - "type": "list" + "type": "string" + }, + { + "description": "the VLAN for the physical network", + "length": 255, + "name": "vlan", + "required": false, + "type": "string" } ], "related": "", @@ -107602,18 +107923,13 @@ }, {}, { - "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the vlan of the physical network", - "name": "vlan", + "description": "state of the physical network", + "name": "state", "type": "string" }, { @@ -107622,18 +107938,19 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Broadcast domain range of the physical network", + "name": "broadcastdomainrange", + "type": "string" }, + {}, { - "description": "state of the physical network", - "name": "state", + "description": "zone id of the physical network", + "name": "zoneid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "zone name of the physical network", + "name": "zonename", "type": "string" }, { @@ -107642,13 +107959,13 @@ "type": "string" }, { - "description": "the uuid of the physical network", - "name": "id", + "description": "the vlan of the physical network", + "name": "vlan", "type": "string" }, { - "description": "name of the physical network", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -107656,10 +107973,14 @@ "name": "domainid", "type": "string" }, - {}, { - "description": "zone id of the physical network", - "name": "zoneid", + "description": "name of the physical network", + "name": "name", + "type": "string" + }, + { + "description": "the uuid of the physical network", + "name": "id", "type": "string" } ], @@ -107689,247 +108010,88 @@ "related": "listSharedFileSystems,changeSharedFileSystemDiskOffering,changeSharedFileSystemServiceOffering", "response": [ { - "description": "name of the shared filesystem", - "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", - "type": "string" - }, - { - "description": "the ID of the domain associated with the shared filesystem", - "name": "domainid", - "type": "string" - }, - { - "description": "the account associated with the shared filesystem", - "name": "account", - "type": "string" - }, - { - "description": "size of the shared filesystem", - "name": "size", - "type": "long" - }, - {}, - { - "description": "the state of the shared filesystem", - "name": "state", + "description": "description of the shared filesystem", + "name": "description", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", + "description": "the list of nics associated with the shared filesystem", + "name": "nic", "response": [ { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "tag value", - "name": "value", - "type": "string" + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" }, { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", - "type": "string" + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" }, { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "Network name of the shared filesystem", - "name": "networkname", - "type": "string" - }, - { - "description": "provisioning type used in the shared filesystem", - "name": "provisioningtype", - "type": "string" - }, - { - "description": "ID of the availability zone", - "name": "zoneid", - "type": "string" - }, - { - "description": "the project name of the shared filesystem", - "name": "project", - "type": "string" - }, - { - "description": "the filesystem format", - "name": "filesystem", - "type": "string" - }, - { - "description": "the shared filesystem's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "the bytes allocated", - "name": "virtualsize", - "type": "long" - }, - { - "description": "ID of the storage fs vm", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the shared filesystem's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "the read (IO) of disk on the shared filesystem", - "name": "diskioread", - "type": "long" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the disk utilization", - "name": "utilization", - "type": "string" - }, - { - "description": "name of the storage pool hosting the data volume", - "name": "storage", - "type": "string" - }, - { - "description": "disk offering ID for the shared filesystem", - "name": "diskofferingid", - "type": "string" - }, - { - "description": "disk offering for the shared filesystem", - "name": "diskofferingname", - "type": "string" - }, - { - "description": "description of the shared filesystem", - "name": "description", - "type": "string" - }, - {}, - { - "description": "size of the shared filesystem in GiB", - "name": "sizegb", - "type": "string" - }, - { - "description": "path of the domain to which the shared filesystem", - "name": "domainpath", - "type": "string" - }, - { - "description": "the list of nics associated with the shared filesystem", - "name": "nic", - "response": [ - { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the name of the corresponding network", + "name": "networkname", "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": "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", + "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 extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" }, { "description": "the isolation uri of the nic", @@ -107937,13 +108099,18 @@ "type": "string" }, { - "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": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { @@ -107952,117 +108119,199 @@ "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", + "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": "the gateway of the nic", + "name": "gateway", "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", + "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the netmask of the nic", + "name": "netmask", "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": "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 cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + } + ], + "type": "list" + }, + { + "description": "path to mount the shared filesystem", + "name": "path", + "type": "string" + }, + { + "description": "service offering for the shared filesystem", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "size of the shared filesystem", + "name": "size", + "type": "long" + }, + { + "description": "size of the shared filesystem in GiB", + "name": "sizegb", + "type": "string" + }, + { + "description": "the list of resource tags associated", + "name": "tags", + "response": [ { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "resource type", + "name": "resourcetype", + "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "tag key name", + "name": "key", "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": "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": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" + "description": "tag value", + "name": "value", + "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" } ], - "type": "list" + "type": "set" + }, + { + "description": "name of the storage pool hosting the data volume", + "name": "storage", + "type": "string" + }, + { + "description": "the project name of the shared filesystem", + "name": "project", + "type": "string" + }, + { + "description": "ID of the storage fs vm", + "name": "vmstate", + "type": "string" + }, + { + "description": "the shared filesystem's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "service offering ID for the shared filesystem", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "the filesystem format", + "name": "filesystem", + "type": "string" + }, + { + "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", + "type": "string" + }, + { + "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 write (IO) of disk on the shared filesystem", @@ -108075,8 +108324,18 @@ "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "name of the shared filesystem", + "name": "name", + "type": "string" + }, + { + "description": "the shared filesystem provider", + "name": "provider", + "type": "string" + }, + { + "description": "the disk utilization", + "name": "utilization", "type": "string" }, { @@ -108085,44 +108344,106 @@ "type": "string" }, { - "description": "name of the storage fs data volume", - "name": "volumename", + "description": "ID of the shared filesystem", + "name": "id", "type": "string" }, { - "description": "disk offering display text for the shared filesystem", - "name": "diskofferingdisplaytext", + "description": "ID of the storage fs data volume", + "name": "volumeid", + "type": "string" + }, + { + "description": "Network ID of the shared filesystem", + "name": "networkid", + "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": "path of the domain to which the shared filesystem", + "name": "domainpath", + "type": "string" + }, + { + "description": "the state of the shared filesystem", + "name": "state", "type": "string" }, + { + "description": "the read (IO) of disk on the shared filesystem", + "name": "diskioread", + "type": "long" + }, { "description": "the domain associated with the shared filesystem", "name": "domain", "type": "string" }, { - "description": "ID of the shared filesystem", - "name": "id", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "ID of the storage fs vm", - "name": "vmstate", + "description": "the shared filesystem's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "Network name of the shared filesystem", + "name": "networkname", "type": "string" }, + {}, { - "description": "the shared filesystem provider", - "name": "provider", + "description": "the account associated with the shared filesystem", + "name": "account", + "type": "string" + }, + { + "description": "ID of the storage pool hosting the data volume", + "name": "storageid", "type": "string" }, + { + "description": "the bytes actually consumed on disk", + "name": "physicalsize", + "type": "long" + }, { "description": "the project ID of the shared filesystem", "name": "projectid", "type": "string" }, { - "description": "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": "ID of the storage fs vm", + "name": "virtualmachineid", "type": "string" + }, + { + "description": "disk offering ID for the shared filesystem", + "name": "diskofferingid", + "type": "string" + }, + { + "description": "the bytes allocated", + "name": "virtualsize", + "type": "long" } ], "since": "4.20.0" @@ -108133,47 +108454,47 @@ "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 maximum X resolution", "length": 255, - "name": "gpucardid", - "related": "", - "required": true, - "type": "uuid" + "name": "maxresolutionx", + "required": false, + "type": "long" }, { - "description": "the maximum Y resolution", + "description": "the video RAM size in MB", "length": 255, - "name": "maxresolutiony", + "name": "videoram", "required": false, "type": "long" }, { - "description": "the description of the vGPU profile", + "description": "the name of the vGPU profile", "length": 255, - "name": "description", - "required": false, + "name": "name", + "required": true, "type": "string" }, { - "description": "the maximum X resolution", + "description": "the description of the vGPU profile", "length": 255, - "name": "maxresolutionx", + "name": "description", "required": false, - "type": "long" + "type": "string" }, { - "description": "the video RAM size in MB", + "description": "the GPU card ID associated with this GPU device", "length": 255, - "name": "videoram", - "required": false, - "type": "long" + "name": "gpucardid", + "related": "", + "required": true, + "type": "uuid" }, { "description": "the maximum number of display heads", @@ -108192,14 +108513,20 @@ ], "related": "", "response": [ + {}, { - "description": "the ID of the GPU card associated with this vGPU profile", - "name": "gpucardid", - "type": "string" + "description": "the maximum Y resolution", + "name": "maxresolutiony", + "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the maximum number of display heads", + "name": "maxheads", + "type": "long" + }, + { + "description": "the device ID of the GPU card", + "name": "deviceid", "type": "string" }, { @@ -108207,72 +108534,66 @@ "name": "vendorname", "type": "string" }, - {}, { - "description": "the video RAM size in MB", - "name": "videoram", + "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": "the name of the vGPU profile", + "name": "gpucardname", + "type": "string" }, { - "description": "the maximum Y resolution", - "name": "maxresolutiony", - "type": "long" + "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 video RAM size in MB", + "name": "videoram", + "type": "long" }, - {}, { - "description": "the device ID of the GPU card", - "name": "deviceid", + "description": "the description of the vGPU profile", + "name": "description", "type": "string" }, { - "description": "the maximum X resolution", - "name": "maxresolutionx", + "description": "the maximum number of vGPUs per physical GPU", + "name": "maxvgpuperphysicalgpu", "type": "long" }, { - "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 name of the vGPU profile", - "name": "gpucardname", + "description": "the vendor ID of the GPU card", + "name": "vendorid", "type": "string" }, { - "description": "the vendor ID of the GPU card", - "name": "vendorid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "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 name of the GPU card", "name": "devicename", "type": "string" }, + {}, { - "description": "the description of the vGPU profile", - "name": "description", + "description": "the ID of the GPU card", + "name": "id", "type": "string" - }, - { - "description": "the maximum number of display heads", - "name": "maxheads", - "type": "long" } ], "since": "4.21.0" @@ -108292,16 +108613,16 @@ } ], "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", @@ -108322,11 +108643,11 @@ "name": "listTungstenFabricFirewallRule", "params": [ { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { "description": "the ID of zone", @@ -108336,13 +108657,6 @@ "required": false, "type": "uuid" }, - { - "description": "the uuid of Tungsten-Fabric firewall policy", - "length": 255, - "name": "firewallpolicyuuid", - "required": false, - "type": "string" - }, { "description": "the uuid of Tungsten-Fabric firewall rule", "length": 255, @@ -108351,91 +108665,99 @@ "type": "string" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" + }, + { + "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", + "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": "Tungsten-Fabric firewall rule service group", + "name": "servicegroup", "type": "string" }, { - "description": "Tungsten-Fabric firewall rule direction", - "name": "direction", + "description": "Tungsten-Fabric firewall rule action", + "name": "action", "type": "string" }, { - "description": "Tungsten-Fabric firewall rule destination network", - "name": "destnetwork", + "description": "Tungsten-Fabric firewall rule source tag", + "name": "srctag", "type": "string" }, {}, { - "description": "Tungsten-Fabric firewall rule name", - "name": "name", + "description": "Tungsten-Fabric firewall rule destination tag", + "name": "desttag", "type": "string" }, + {}, { - "description": "Tungsten-Fabric firewall rule tag type", - "name": "tagtype", + "description": "Tungsten-Fabric firewall rule 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 firewall rule source network", + "name": "srcnetwork", + "type": "string" }, { - "description": "Tungsten-Fabric firewall rule destination tag", - "name": "desttag", + "description": "Tungsten-Fabric firewall rule source address group", + "name": "srcaddressgroup", "type": "string" }, { - "description": "Tungsten-Fabric firewall rule service group", - "name": "servicegroup", + "description": "Tungsten-Fabric firewall rule name", + "name": "name", "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 source address group", - "name": "srcaddressgroup", + "description": "Tungsten-Fabric firewall rule tag type", + "name": "tagtype", "type": "string" }, { - "description": "Tungsten-Fabric firewall rule uuid", - "name": "uuid", + "description": "Tungsten-Fabric firewall rule destination network", + "name": "destnetwork", "type": "string" }, { - "description": "Tungsten-Fabric firewall rule source network", - "name": "srcnetwork", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "Tungsten-Fabric firewall rule action", - "name": "action", + "description": "Tungsten-Fabric firewall rule direction", + "name": "direction", "type": "string" }, { @@ -108444,11 +108766,10 @@ "type": "long" }, { - "description": "Tungsten-Fabric firewall rule destination address group", - "name": "destaddressgroup", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" - }, - {} + } ] }, { @@ -108459,16 +108780,17 @@ { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "", + "description": "ID of the zone", "length": 255, - "name": "pagesize", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "integer" + "type": "uuid" }, { "description": "List by keyword", @@ -108478,34 +108800,28 @@ "type": "string" }, { - "description": "ID of the zone", + "description": "", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" } ], "related": "deleteNetrisProvider", "response": [ { - "description": "Netris provider uuid", - "name": "uuid", + "description": "Netris Provider site", + "name": "sitename", "type": "string" }, { - "description": "Zone ID to which the Netris Provider is associated with", - "name": "zoneid", + "description": "the UUID of the latest async 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": "Netris Admin tenant name", - "name": "tenantname", + "description": "Netris provider uuid", + "name": "uuid", "type": "string" }, { @@ -108513,24 +108829,19 @@ "name": "name", "type": "string" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "Netris Tag for vNets", "name": "netristag", "type": "string" }, { - "description": "Netris Provider site", - "name": "sitename", + "description": "Zone ID to which the Netris Provider is associated with", + "name": "zoneid", "type": "string" }, { - "description": "Zone name to which the Netris Provider is associated with", - "name": "zonename", + "description": "Netris Admin tenant name", + "name": "tenantname", "type": "string" }, {}, @@ -108539,6 +108850,16 @@ "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" + }, + { + "description": "Zone name to which the Netris Provider is associated with", + "name": "zonename", + "type": "string" } ], "since": "4.21.0" @@ -108549,9 +108870,9 @@ "name": "createProject", "params": [ { - "description": "account who will be Admin for the project", + "description": "The display text of the project, defaults to the 'name´.", "length": 255, - "name": "account", + "name": "displaytext", "required": false, "type": "string" }, @@ -108565,27 +108886,19 @@ "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", + "description": "domain ID of the account owning a project", "length": 255, - "name": "accountid", - "related": "disableAccount,enableAccount,updateAccount,markDefaultZoneForAccount,listAccounts", + "name": "domainid", + "related": "createDomain,listDomains,listDomains", "required": false, "type": "uuid" }, { - "description": "domain ID of the account owning a project", + "description": "account who will be Admin for the project", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { "description": "name of the project", @@ -108593,43 +108906,36 @@ "name": "name", "required": true, "type": "string" + }, + { + "description": "ID of the account owning a project", + "length": 255, + "name": "accountid", + "related": "disableAccount,enableAccount,updateAccount,markDefaultZoneForAccount,listAccounts", + "required": false, + "type": "uuid" } ], "related": "", "response": [ { - "description": "the total memory (in MB) available to be created for this project", - "name": "memoryavailable", - "type": "string" - }, - { - "description": "the total number of cpu cores owned by project", - "name": "cputotal", - "type": "long" - }, - { - "description": "the total number of snapshots available for this project", - "name": "snapshotavailable", + "description": "the total object storage space (in GiB) available to the project", + "name": "objectstorageavailable", "type": "string" }, { - "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 memory (in MB) owned by project", - "name": "memorytotal", - "type": "long" - }, - { - "description": "the total number of buckets stored by this project", - "name": "buckettotal", - "type": "long" + "description": "the date this project was created", + "name": "created", + "type": "date" }, { - "description": "the total object storage space (in GiB) the project can own", - "name": "objectstoragelimit", + "description": "the project account name of the project", + "name": "projectaccountname", "type": "string" }, { @@ -108638,28 +108944,33 @@ "type": "long" }, { - "description": "the total number of snapshots stored by this project", - "name": "snapshottotal", - "type": "long" + "description": "the total memory (in MB) the project can own", + "name": "memorylimit", + "type": "string" }, { - "description": "the total number of public ip addresses available for this project to acquire", - "name": "ipavailable", + "description": "the displaytext of the project", + "name": "displaytext", "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 secondary storage space (in GiB) the project can own", - "name": "secondarystoragelimit", + "description": "the total backup storage space (in GiB) available to the project", + "name": "backupstorageavailable", "type": "string" }, { - "description": "the total number of virtual machines that can be deployed by this project", - "name": "vmlimit", + "description": "the total number of backups which can be stored by this project", + "name": "backuplimit", + "type": "string" + }, + { + "description": "the total number of gpus available to be created for this project", + "name": "gpuavailable", "type": "string" }, { @@ -108668,58 +108979,64 @@ "type": "string" }, { - "description": "the total number of templates available to be created by this project", - "name": "templateavailable", + "description": "the state of the project", + "name": "state", "type": "string" }, { - "description": "the total number of cpu cores the project can own", - "name": "cpulimit", + "description": "the total number of vpcs available to be created for this project", + "name": "vpcavailable", "type": "string" }, { - "description": "the date this project was created", - "name": "created", - "type": "date" + "description": "the domain name where the project belongs to", + "name": "domain", + "type": "string" }, { - "description": "the total number of public ip addresses this project can acquire", - "name": "iplimit", + "description": "the total secondary storage space (in GiB) the project can own", + "name": "secondarystoragelimit", "type": "string" }, { - "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 cpu cores available to be created for this project", - "name": "cpuavailable", + "description": "the total number of templates which can be created by this project", + "name": "templatelimit", "type": "string" }, { - "description": "the total volume being used by this project", - "name": "volumetotal", + "description": "the total number of buckets stored by this project", + "name": "buckettotal", "type": "long" }, { - "description": "the total object storage space (in GiB) owned by the project", - "name": "objectstoragetotal", + "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 public ip addresses allocated for this project", + "name": "iptotal", + "type": "long" }, { - "description": "the id of the project", - "name": "id", - "type": "string" + "description": "the total number of templates which have been created by this project", + "name": "templatetotal", + "type": "long" }, { - "description": "the total memory (in MB) the project can own", - "name": "memorylimit", + "description": "the account name of the project's owners", + "name": "owner", + "type": "list" + }, + { + "description": "the total number of cpu cores the project can own", + "name": "cpulimit", "type": "string" }, { @@ -108728,39 +109045,48 @@ "type": "string" }, { - "description": "the total number of backups which can be stored by this project", - "name": "backuplimit", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "the total number of virtual machines stopped for this project", - "name": "vmstopped", + "description": "the total number of virtual machines running for this project", + "name": "vmrunning", "type": "integer" }, + { + "description": "The tagged resource limit and count for the project", + "name": "taggedresources", + "type": "list" + }, + { + "description": "the total volume which can be used by this project", + "name": "volumelimit", + "type": "string" + }, { "description": "the total number of networks available to be created for this project", "name": "networkavailable", "type": "string" }, { - "description": "the total number of virtual machines running for this project", - "name": "vmrunning", - "type": "integer" + "description": "the total volume being used by this project", + "name": "volumetotal", + "type": "long" }, { - "description": "the total number of public ip addresses allocated for this project", - "name": "iptotal", + "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", - "type": "long" + "description": "the total number of gpus the project can own", + "name": "gpulimit", + "type": "string" }, { - "description": "the total number of networks owned by project", - "name": "networktotal", + "description": "the total number of gpus owned by project", + "name": "gputotal", "type": "long" }, { @@ -108769,19 +109095,25 @@ "type": "string" }, { - "description": "the account name of the project's owners", - "name": "owner", - "type": "list" + "description": "the total backup storage space (in GiB) the project can own", + "name": "backupstoragelimit", + "type": "string" }, { - "description": "the total primary storage space (in GiB) the project can own", - "name": "primarystoragelimit", - "type": "string" + "description": "the total object storage space (in GiB) owned by the project", + "name": "objectstoragetotal", + "type": "long" }, { - "description": "the total volume which can be used by this project", - "name": "volumelimit", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + { + "description": "the total number of backups stored by this project", + "name": "backuptotal", + "type": "long" }, { "description": "Base64 string representation of the resource icon", @@ -108789,33 +109121,53 @@ "type": "resourceiconresponse" }, { - "description": "the project account name of the project", - "name": "projectaccountname", + "description": "the name of the project", + "name": "name", "type": "string" }, { - "description": "the total number of backups stored by this project", - "name": "backuptotal", + "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 memory (in MB) available to be created for this project", + "name": "memoryavailable", + "type": "string" }, { - "description": "the domain name where the project belongs to", - "name": "domain", + "description": "the domain id the project belongs to", + "name": "domainid", "type": "string" }, { - "description": "the total volume available for this project", - "name": "volumeavailable", + "description": "the total number of snapshots available for this project", + "name": "snapshotavailable", "type": "string" }, { - "description": "the total number of gpus the project can own", - "name": "gpulimit", + "description": "the total number of buckets which can be stored by this project", + "name": "bucketlimit", + "type": "string" + }, + { + "description": "the total object storage space (in GiB) the project can own", + "name": "objectstoragelimit", + "type": "string" + }, + { + "description": "the total number of backups available to this project", + "name": "backupavailable", + "type": "string" + }, + { + "description": "the total number of virtual machines stopped for this project", + "name": "vmstopped", + "type": "integer" + }, + { + "description": "the total number of public ip addresses available for this project to acquire", + "name": "ipavailable", "type": "string" }, { @@ -108823,18 +109175,18 @@ "name": "tags", "response": [ { - "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": "tag key name", + "name": "key", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -108843,28 +109195,28 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "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": "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": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -108873,107 +109225,76 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "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", - "type": "string" - }, - { - "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", - "type": "long" - }, - { - "description": "the total number of buckets which can be stored by this project", - "name": "bucketlimit", - "type": "string" - }, - { - "description": "the total number of templates which have been created by this project", - "name": "templatetotal", + "description": "the total memory (in MB) owned by project", + "name": "memorytotal", "type": "long" }, { - "description": "the name of the project", - "name": "name", - "type": "string" - }, - {}, - { - "description": "the domain id the project belongs to", - "name": "domainid", + "description": "the total number of networks the project can own", + "name": "networklimit", "type": "string" }, { - "description": "the total object storage space (in GiB) available to the project", - "name": "objectstorageavailable", + "description": "the total volume available for this project", + "name": "volumeavailable", "type": "string" }, { - "description": "the total number of gpus owned by project", - "name": "gputotal", + "description": "the total number of networks owned by project", + "name": "networktotal", "type": "long" }, { - "description": "the total secondary storage space (in GiB) owned by project", - "name": "secondarystoragetotal", - "type": "float" - }, - { - "description": "the total number of vpcs the project can own", - "name": "vpclimit", + "description": "the total number of cpu cores available to be created for this project", + "name": "cpuavailable", "type": "string" }, { - "description": "the state of the project", - "name": "state", + "description": "the total secondary storage space (in GiB) available to be used for this project", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "the total number of vpcs available to be created for this project", - "name": "vpcavailable", + "description": "the total number of templates available to be created by this project", + "name": "templateavailable", "type": "string" }, { - "description": "the total number of backups available to this project", - "name": "backupavailable", - "type": "string" + "description": "the total primary storage space (in GiB) owned by project", + "name": "primarystoragetotal", + "type": "long" }, { - "description": "the total number of templates which can be created by this project", - "name": "templatelimit", + "description": "the total number of buckets available to this project", + "name": "bucketavailable", "type": "string" }, { - "description": "the total backup storage space (in GiB) available to the project", - "name": "backupstorageavailable", - "type": "string" + "description": "the total secondary storage space (in GiB) owned by project", + "name": "secondarystoragetotal", + "type": "float" }, { - "description": "the displaytext of the project", - "name": "displaytext", - "type": "string" + "description": "the total backup storage space (in GiB) owned by the project", + "name": "backupstoragetotal", + "type": "long" }, { - "description": "the total number of gpus available to be created for this project", - "name": "gpuavailable", + "description": "the total number of vpcs the project can own", + "name": "vpclimit", "type": "string" }, { - "description": "the total number of networks the project can own", - "name": "networklimit", + "description": "the total number of public ip addresses this project can acquire", + "name": "iplimit", "type": "string" } ], @@ -108992,6 +109313,14 @@ "required": true, "type": "uuid" }, + { + "description": "Force assign the certificate. If there is a certificate assigned to the LB, it will be removed at first.", + "length": 255, + "name": "forced", + "required": false, + "since": "4.22", + "type": "boolean" + }, { "description": "the ID of the load balancer rule", "length": 255, @@ -109002,28 +109331,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": "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" - } + {} ] }, { @@ -109049,14 +109378,14 @@ { "description": "Credentials to access the Cisco VNMC Controller API", "length": 255, - "name": "username", + "name": "password", "required": true, "type": "string" }, { "description": "Credentials to access the Cisco VNMC Controller API", "length": 255, - "name": "password", + "name": "username", "required": true, "type": "string" } @@ -109071,14 +109400,14 @@ {}, {}, {}, - {}, - {}, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, + {}, + {}, {} ] }, @@ -109087,14 +109416,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 +109424,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, @@ -109120,13 +109449,48 @@ "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the date when this account was created", + "name": "created", + "type": "date" }, { - "description": "the total number of networks owned by account", - "name": "networktotal", + "description": "the total object storage space (in GiB) available to the account", + "name": "objectstorageavailable", + "type": "string" + }, + { + "description": "The tagged resource limit and count for the account", + "name": "taggedresources", + "type": "list" + }, + { + "description": "true if the account requires cleanup", + "name": "iscleanuprequired", + "type": "boolean" + }, + { + "description": "the total number of public ip addresses this account can acquire", + "name": "iplimit", + "type": "string" + }, + { + "description": "the total object storage space (in GiB) the account can own", + "name": "objectstoragelimit", + "type": "string" + }, + { + "description": "the total memory (in MB) owned by account", + "name": "memorytotal", + "type": "long" + }, + { + "description": "the id of the account", + "name": "id", + "type": "string" + }, + { + "description": "the total backup storage space (in GiB) owned by the account", + "name": "backupstoragetotal", "type": "long" }, { @@ -109135,55 +109499,155 @@ "type": "string" }, { - "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 gpus the account can own", + "name": "gpulimit", + "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 the account can own", + "name": "networklimit", + "type": "string" + }, + { + "description": "the network domain", + "name": "networkdomain", + "type": "string" + }, + { + "description": "the total number of projects the account can own", + "name": "projectlimit", + "type": "string" + }, + { + "description": "the total number of networks owned by account", + "name": "networktotal", + "type": "long" + }, + { + "description": "the total volume available for this account", + "name": "volumeavailable", + "type": "string" + }, + { + "description": "the total number of cpu cores owned by account", + "name": "cputotal", + "type": "long" + }, + { + "description": "the total number of gpus owned by account", + "name": "gputotal", + "type": "long" + }, + { + "description": "the total number of vpcs available to be created for this account", + "name": "vpcavailable", "type": "string" }, + { + "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": "id of the Domain the account belongs to", + "name": "domainid", + "type": "string" + }, + { + "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 object storage space (in GiB) owned by the account", "name": "objectstoragetotal", "type": "long" }, { - "description": "the total number of snapshots available for this account", - "name": "snapshotavailable", + "description": "the total number of vpcs owned by account", + "name": "vpctotal", + "type": "long" + }, + { + "description": "the state of the account", + "name": "state", "type": "string" }, - {}, { - "description": "the total number of backups available to this account", - "name": "backupavailable", + "description": "the total number of virtual machines deployed by this account", + "name": "vmtotal", + "type": "long" + }, + { + "description": "the total number of projects being administrated by this account", + "name": "projecttotal", + "type": "long" + }, + { + "description": "the total number of templates available to be created by this account", + "name": "templateavailable", "type": "string" }, { - "description": "the total memory (in MB) owned by account", - "name": "memorytotal", + "description": "the name of the account", + "name": "name", + "type": "string" + }, + { + "description": "the total number of templates which can be created by this account", + "name": "templatelimit", + "type": "string" + }, + { + "description": "the total number of buckets available to this account", + "name": "bucketavailable", + "type": "string" + }, + { + "description": "the total number of buckets stored by this account", + "name": "buckettotal", "type": "long" }, { - "description": "the total number of gpus owned by account", - "name": "gputotal", + "description": "the total number of public ip addresses allocated for this account", + "name": "iptotal", "type": "long" }, { - "description": "true if account is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the total number of snapshots stored by this account", + "name": "snapshottotal", + "type": "long" }, { - "description": "the total memory (in MB) available to be created for this account", - "name": "memoryavailable", + "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", + "name": "roletype", "type": "string" }, { - "description": "details for the account", - "name": "accountdetails", - "type": "map" + "description": "the list of acl groups that account belongs to", + "name": "groups", + "type": "list" }, { "description": "the total backup storage space (in GiB) available to the account", @@ -109191,13 +109655,33 @@ "type": "string" }, { - "description": "the total secondary storage space (in GiB) the account can own", - "name": "secondarystoragelimit", + "description": "the total memory (in MB) available to be created for this account", + "name": "memoryavailable", "type": "string" }, { - "description": "the total number of buckets which can be stored by this account", - "name": "bucketlimit", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the total number of gpus available to be created for this account", + "name": "gpuavailable", + "type": "string" + }, + { + "description": "path of the Domain the account belongs to", + "name": "domainpath", + "type": "string" + }, + { + "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" }, { @@ -109206,49 +109690,68 @@ "type": "string" }, { - "description": "the total object storage space (in GiB) the account can own", - "name": "objectstoragelimit", + "description": "the total number of buckets which can be stored by this account", + "name": "bucketlimit", "type": "string" }, { - "description": "the date when this account was created", - "name": "created", - "type": "date" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, - {}, { - "description": "the total number of backups which can be stored by this account", - "name": "backuplimit", + "description": "the total primary storage space (in GiB) available to be used for this account", + "name": "primarystorageavailable", "type": "string" }, { - "description": "the total number of public ip addresses available for this account to acquire", - "name": "ipavailable", + "description": "account type (admin, domain-admin, user)", + "name": "accounttype", + "type": "integer" + }, + { + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { - "description": "the total number of vpcs available to be created for this account", - "name": "vpcavailable", + "description": "the total number of virtual machines available for this account to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "the total memory (in MB) the account can own", - "name": "memorylimit", + "description": "the total number of projects available for administration by this account", + "name": "projectavailable", "type": "string" }, { - "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", - "name": "roletype", + "description": "the total number of snapshots available for this account", + "name": "snapshotavailable", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total number of snapshots which can be stored by this account", + "name": "snapshotlimit", "type": "string" }, { - "description": "name of the Domain the account belongs to", - "name": "domain", + "description": "the total number of backups which can be stored by this account", + "name": "backuplimit", + "type": "string" + }, + { + "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 total primary storage space (in GiB) the account can own", + "name": "primarystoragelimit", "type": "string" }, { @@ -109256,25 +109759,30 @@ "name": "user", "response": [ { - "description": "the user email address", - "name": "email", + "description": "the type of the role", + "name": "roletype", "type": "string" }, { - "description": "the account ID of the user", - "name": "accountid", + "description": "the domain name of the user", + "name": "domain", "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" }, { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", + "description": "the user state", + "name": "state", "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", @@ -109285,34 +109793,24 @@ "name": "domainid", "type": "string" }, - { - "description": "the user state", - "name": "state", - "type": "string" - }, { "description": "the user lastname", "name": "lastname", "type": "string" }, - { - "description": "the domain name of the user", - "name": "domain", - "type": "string" - }, { "description": "the ID of the role", "name": "roleid", "type": "string" }, { - "description": "the user ID", - "name": "id", - "type": "string" + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", + "type": "boolean" }, { - "description": "the timezone user was created in", - "name": "timezone", + "description": "the name of the role", + "name": "rolename", "type": "string" }, { @@ -109321,23 +109819,28 @@ "type": "apikeyaccess" }, { - "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": "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": "the account ID of the user", + "name": "accountid", "type": "string" }, { - "description": "the type of the role", - "name": "roletype", + "description": "the api key of the user", + "name": "apikey", + "type": "string" + }, + { + "description": "the user firstname", + "name": "firstname", "type": "string" }, { @@ -109346,23 +109849,23 @@ "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": "the date and time the user account was created", - "name": "created", - "type": "date" + "description": "the user ID", + "name": "id", + "type": "string" }, { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" + "description": "the user email address", + "name": "email", + "type": "string" }, { - "description": "the name of the role", - "name": "rolename", + "description": "the secret key of the user", + "name": "secretkey", "type": "string" }, { @@ -109371,116 +109874,46 @@ "type": "boolean" }, { - "description": "the api key of the user", - "name": "apikey", - "type": "string" + "description": "the date and time the user account was created", + "name": "created", + "type": "date" }, { - "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 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", - "type": "string" + "description": "the account name of the user", + "name": "account", + "type": "string" + } + ], + "type": "list" }, { - "description": "the total number of buckets stored by this account", - "name": "buckettotal", + "description": "the total number of backups stored by this account", + "name": "backuptotal", "type": "long" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "the total secondary storage space (in GiB) owned by account", + "name": "secondarystoragetotal", + "type": "float" }, { - "description": "the total volume being used by this account", - "name": "volumetotal", + "description": "the total primary storage space (in GiB) owned by account", + "name": "primarystoragetotal", "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the total number of virtual machines stopped for this account", + "name": "vmstopped", "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", - "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", - "type": "string" - }, - { - "description": "the total object storage space (in GiB) available to the account", - "name": "objectstorageavailable", - "type": "string" - }, - { - "description": "the id of the account", - "name": "id", - "type": "string" - }, - { - "description": "The tagged resource limit and count for the account", - "name": "taggedresources", - "type": "list" - }, - { - "description": "id of the Domain the account belongs to", - "name": "domainid", + "description": "the default zone of the account", + "name": "defaultzoneid", "type": "string" }, { - "description": "the total number of cpu cores available to be created for this account", - "name": "cpuavailable", + "description": "the name of the role", + "name": "rolename", "type": "string" }, { @@ -109489,63 +109922,18 @@ "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", - "type": "string" - }, - { - "description": "the total number of gpus available to be created for this account", - "name": "gpuavailable", - "type": "string" - }, - { - "description": "the total number of virtual machines deployed by this account", - "name": "vmtotal", - "type": "long" - }, - { - "description": "the 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 public ip addresses this account can acquire", - "name": "iplimit", - "type": "string" - }, - { - "description": "the total volume available for this account", - "name": "volumeavailable", - "type": "string" - }, - { - "description": "the total number of vpcs the account can own", - "name": "vpclimit", + "description": "the total memory (in MB) the account can own", + "name": "memorylimit", "type": "string" }, { - "description": "the name of the account", - "name": "name", + "description": "name of the Domain the account belongs to", + "name": "domain", "type": "string" }, { - "description": "the total primary storage space (in GiB) the account can own", - "name": "primarystoragelimit", + "description": "the total number of virtual machines that can be deployed by this account", + "name": "vmlimit", "type": "string" }, { @@ -109553,108 +109941,64 @@ "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 backups available to this account", + "name": "backupavailable", "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", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "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", + "description": "true if account is default, false otherwise", + "name": "isdefault", "type": "boolean" - }, - { - "description": "the total number of templates which can be created by this account", - "name": "templatelimit", - "type": "string" - }, - { - "description": "the total number of projects being administrated by this account", - "name": "projecttotal", - "type": "long" } ], "since": "4.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", - "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", @@ -109666,68 +110010,53 @@ "name": "jobstatus", "type": "integer" }, - {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - {} + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + } ], - "since": "4.20.0" + "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.", @@ -109742,6 +110071,13 @@ "required": true, "type": "uuid" }, + { + "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": "the service offering ID to apply to the system vm", "length": 255, @@ -109749,52 +110085,44 @@ "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", - "length": 255, - "name": "details", - "required": false, - "type": "map" } ], "related": "startSystemVm", "response": [ { - "description": "the ID of the system VM", - "name": "id", + "description": "the private IP address for the system VM", + "name": "privateip", "type": "string" }, { - "description": "the gateway for the system VM", - "name": "gateway", + "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", - "type": "string" + "description": "the last disconnected date of host", + "name": "disconnected", + "type": "date" }, { - "description": "the network domain for the system VM", - "name": "networkdomain", + "description": "the Zone ID for the system VM", + "name": "zoneid", "type": "string" }, { - "description": "the systemvm agent version", - "name": "version", + "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 hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, - {}, { - "description": "the ID of the service offering of the system 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 number of active console sessions for the console proxy system vm", @@ -109802,44 +110130,54 @@ "type": "integer" }, { - "description": "the name of the system VM", - "name": "name", + "description": "the gateway for the system VM", + "name": "gateway", "type": "string" }, { - "description": "CPU arch of the system VM", - "name": "arch", + "description": "the link local MAC address for the system vm", + "name": "linklocalmacaddress", "type": "string" }, { - "description": "the first DNS for the system VM", - "name": "dns1", + "description": "the link local IP address for the system vm", + "name": "linklocalip", "type": "string" }, { - "description": "the template name for the system VM", - "name": "templatename", + "description": "the agent state of the system VM", + "name": "agentstate", "type": "string" }, { - "description": "the private netmask for the system VM", - "name": "privatenetmask", + "description": "the Pod name for the system VM", + "name": "podname", "type": "string" }, { - "description": "the public netmask for the system VM", - "name": "publicnetmask", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "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 private MAC address for the system VM", "name": "privatemacaddress", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "guest vlan range", + "name": "guestvlan", + "type": "string" }, { "description": "true if the entity/resource has annotations", @@ -109847,80 +110185,81 @@ "type": "boolean" }, { - "description": "the last disconnected date of host", - "name": "disconnected", - "type": "date" + "description": "the first DNS for the system VM", + "name": "dns1", + "type": "string" }, { - "description": "the name of the service offering of the system virtual machine.", - "name": "serviceofferingname", + "description": "the control state of the host for the system VM", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the second DNS for the system VM", - "name": "dns2", + "description": "the systemvm agent version", + "name": "version", "type": "string" }, { - "description": "the template ID for the system VM", - "name": "templateid", + "description": "the name of the system VM", + "name": "name", "type": "string" }, { - "description": "the hostname for the system VM", - "name": "hostname", + "description": "the network domain for the system VM", + "name": "networkdomain", + "type": "string" + }, + { + "description": "the ID of the system VM", + "name": "id", "type": "string" }, - {}, { "description": "the date and time the system VM was created", "name": "created", "type": "date" }, { - "description": "the agent state of the system VM", - "name": "agentstate", + "description": "the ID of the service offering of the system virtual machine.", + "name": "serviceofferingid", "type": "string" }, + {}, { - "description": "the link local MAC address for the system vm", - "name": "linklocalmacaddress", + "description": "the private netmask for the system VM", + "name": "privatenetmask", "type": "string" }, { - "description": "the state of the system VM", - "name": "state", + "description": "the template ID for the system VM", + "name": "templateid", "type": "string" }, + {}, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the template name for the system VM", + "name": "templatename", "type": "string" }, { - "description": "the public MAC address for the system VM", - "name": "publicmacaddress", + "description": "the system VM type", + "name": "systemvmtype", "type": "string" }, { - "description": "public vlan range", - "name": "publicvlan", - "type": "list" - }, - { - "description": "the host ID for the system VM", - "name": "hostid", + "description": "the public IP address for the system VM", + "name": "publicip", "type": "string" }, { - "description": "guest vlan range", - "name": "guestvlan", + "description": "the Pod ID for the system VM", + "name": "podid", "type": "string" }, { - "description": "the link local netmask for the system vm", - "name": "linklocalnetmask", - "type": "string" + "description": "public vlan range", + "name": "publicvlan", + "type": "list" }, { "description": "the Zone name for the system VM", @@ -109928,43 +110267,33 @@ "type": "string" }, { - "description": "the system VM type", - "name": "systemvmtype", - "type": "string" - }, - { - "description": "the control state of the host for the system VM", - "name": "hostcontrolstate", + "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 public MAC address for the system VM", + "name": "publicmacaddress", "type": "string" }, { - "description": "the link local IP address for the system vm", - "name": "linklocalip", + "description": "the name of the service offering of the system virtual machine.", + "name": "serviceofferingname", "type": "string" }, { - "description": "the public IP address for the system VM", - "name": "publicip", + "description": "the hostname for the system VM", + "name": "hostname", "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" - }, - { - "description": "the Zone ID for the system VM", - "name": "zoneid", + "description": "the state of the system VM", + "name": "state", "type": "string" }, { - "description": "the Pod name for the system VM", - "name": "podname", + "description": "CPU arch of the system VM", + "name": "arch", "type": "string" } ] @@ -109975,19 +110304,19 @@ "name": "updateSiocInfo", "params": [ { - "description": "Zone ID", + "description": "Notify if IOPS above this value", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "iopsnotifythreshold", "required": true, - "type": "uuid" + "type": "integer" }, { - "description": "Notify if IOPS above this value", + "description": "Storage Pool ID", "length": 255, - "name": "iopsnotifythreshold", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", "required": true, - "type": "integer" + "type": "uuid" }, { "description": "Shares per GB", @@ -110004,32 +110333,32 @@ "type": "integer" }, { - "description": "Storage Pool ID", + "description": "Zone ID", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", + "name": "zoneid", + "related": "listZones", "required": true, "type": "uuid" } ], "related": "", "response": [ + {}, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { "description": "The return message from the operation ('Success' if successful)", "name": "msg", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ], "since": "4.11.0" @@ -110049,6 +110378,11 @@ } ], "response": [ + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, { "description": "any text associated with the success or failure", "name": "displaytext", @@ -110065,11 +110399,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.2.0" @@ -110079,6 +110408,20 @@ "isasync": false, "name": "listConsoleSessions", "params": [ + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "Lists console sessions recursively per domain. If an account ID is informed, only the account's console sessions will be listed. Defaults to false.", + "length": 255, + "name": "isrecursive", + "required": false, + "type": "boolean" + }, { "description": "The domain ID of the account that created the console endpoint.", "length": 255, @@ -110088,157 +110431,137 @@ "type": "uuid" }, { - "description": "IP address of the creator of the console endpoint.", + "description": "IP address of the client that accessed the console session.", "length": 255, - "name": "consoleendpointcreatoraddress", + "name": "clientaddress", "required": false, "type": "string" }, { - "description": "The ID of the user that created the console endpoint.", + "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": "userid", - "related": "disableUser,getUser,listUsers,lockUser", + "name": "acquired", "required": false, - "type": "uuid" + "type": "boolean" }, { "description": "The ID of the virtual machine.", "length": 255, "name": "virtualmachineid", - "related": "assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm", + "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,createVMFromBackup,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "required": false, "type": "uuid" }, { - "description": "Lists console sessions from the specified host.", + "description": "The ID of the console session.", "length": 255, - "name": "hostid", - "related": "declareHostAsDegraded,reconnectHost", + "name": "id", + "related": "listConsoleSessions", "required": false, "type": "uuid" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "", + "description": "Lists console sessions from the specified host.", "length": 255, - "name": "page", + "name": "hostid", + "related": "declareHostAsDegraded,reconnectHost", "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 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": "isrecursive", + "name": "enddate", "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": "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": "activeonly", + "name": "startdate", "required": false, - "type": "boolean" + "type": "date" }, { - "description": "The ID of the console session.", + "description": "The ID of the user that created the console endpoint.", "length": 255, - "name": "id", - "related": "listConsoleSessions", + "name": "userid", + "related": "disableUser,getUser,listUsers,lockUser", "required": false, "type": "uuid" }, { - "description": "IP address of the client that accessed the console session.", - "length": 255, - "name": "clientaddress", - "required": false, - "type": "string" - }, - { - "description": "List by keyword", + "description": "IP address of the creator of the console endpoint.", "length": 255, - "name": "keyword", + "name": "consoleendpointcreatoraddress", "required": false, "type": "string" }, { - "description": "Lists console sessions generated from this date onwards. The recommended format is \"yyyy-MM-dd'T'HH:mm:ssZ\" (e.g.: \"2023-01-01T12:00:00+0100\"); however, the following formats are also accepted: \"yyyy-MM-dd HH:mm:ss\" (e.g.: \"2023-01-01 12:00:00\") and \"yyyy-MM-dd\" (e.g.: \"2023-01-01\" - if the time is not added, it will be interpreted as \"00:00:00\"). If the recommended format is not used, the date will be considered in the server timezone.", + "description": "The ID of the account that created the console endpoint.", "length": 255, - "name": "startdate", + "name": "accountid", + "related": "disableAccount,enableAccount,updateAccount,listAccounts", "required": false, - "type": "date" + "type": "uuid" }, { - "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": "", "length": 255, - "name": "enddate", + "name": "page", "required": false, - "type": "date" + "type": "integer" }, { - "description": "The ID of the account that created the console endpoint.", + "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": "accountid", - "related": "disableAccount,enableAccount,updateAccount,listAccounts", + "name": "activeonly", "required": false, - "type": "uuid" + "type": "boolean" }, { - "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": "List by keyword", "length": 255, - "name": "acquired", + "name": "keyword", "required": false, - "type": "boolean" + "type": "string" } ], "related": "", "response": [ { - "description": "ID of the account that created the console endpoint.", - "name": "accountid", + "description": "Name of the virtual machine.", + "name": "virtualmachinename", "type": "string" }, { - "description": "Domain of the account that created the console endpoint.", - "name": "domain", + "description": "ID of the console session.", + "name": "id", "type": "string" }, { - "description": "Domain ID of the account that created the console endpoint.", - "name": "domainid", + "description": "ID of the virtual machine.", + "name": "virtualmachineid", "type": "string" }, { - "description": "Domain path of the account that created the console endpoint.", - "name": "domainpath", + "description": "Domain of the account that created the console endpoint.", + "name": "domain", "type": "string" }, { - "description": "User that created the console endpoint.", - "name": "user", + "description": "IP address of the creator of the console endpoint.", + "name": "consoleendpointcreatoraddress", "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 user that created the console endpoint.", + "name": "userid", + "type": "string" }, { - "description": "ID of the virtual machine.", - "name": "virtualmachineid", + "description": "IP address of the client that created the console session.", + "name": "clientaddress", "type": "string" }, { @@ -110247,54 +110570,60 @@ "type": "date" }, { - "description": "IP address of the creator of the console endpoint.", - "name": "consoleendpointcreatoraddress", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "IP address of the client that created the console session.", - "name": "clientaddress", + "description": "Name of the host.", + "name": "hostname", "type": "string" }, { - "description": "ID of the console session.", - "name": "id", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "Name of the virtual machine.", - "name": "virtualmachinename", + "description": "ID of the account that created the console endpoint.", + "name": "accountid", "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", + "type": "string" }, { - "description": "ID of the host.", - "name": "hostid", + "description": "Domain path of the account that created the console endpoint.", + "name": "domainpath", "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": "ID of the host.", + "name": "hostid", "type": "string" }, { - "description": "Name of the host.", - "name": "hostname", - "type": "string" + "description": "Date when the console session was acquired.", + "name": "acquired", + "type": "date" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Date when the console session's endpoint was created.", + "name": "created", + "type": "date" + }, + {}, + { + "description": "User that created the console endpoint.", + "name": "user", "type": "string" } ], @@ -110305,38 +110634,60 @@ "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": "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,createVMFromBackup,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "required": true, "type": "uuid" + }, + { + "description": "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" } ], "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": "result of the unmanage VM operation", - "name": "success", - "type": "boolean" - }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" + }, + { + "description": "The ID of the host used for unmanaged Instance", + "name": "hostid", + "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" } ], "since": "4.15.0" @@ -110346,14 +110697,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,65 +110704,31 @@ "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": "the version of template", - "name": "version", + "description": "the template name for the router", + "name": "templatename", "type": "string" }, { - "description": "the hostname for the router", - "name": "hostname", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the Pod name for the router", + "name": "podname", "type": "string" }, { @@ -110428,105 +110737,251 @@ "type": "string" }, { - "description": "CPU arch of the router", - "name": "arch", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the public MAC address for the router", - "name": "publicmacaddress", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "the first DNS for the router", - "name": "dns1", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "the domain associated with the router", - "name": "domain", + "description": "VPC the router belongs to", + "name": "vpcid", "type": "string" }, { - "description": "true if the router template requires upgrader", - "name": "requiresupgrade", - "type": "boolean" - }, - { - "description": "the control state of the host for the router", - "name": "hostcontrolstate", + "description": "path of the Domain the router belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", + "description": "the id of the router", + "name": "id", "type": "string" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the name of the router", - "name": "name", - "type": "string" - }, - {}, - { - "description": "the guest netmask for the router", - "name": "guestnetmask", + "description": "the hostname for the router", + "name": "hostname", "type": "string" }, { - "description": "the version of scripts", - "name": "scriptsversion", - "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 list of nics associated with the router", + "name": "nic", + "response": [ + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "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 ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "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": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + } + ], + "type": "set" }, { - "description": "the ID of the corresponding guest network", - "name": "guestnetworkid", + "description": "the template ID for the router", + "name": "templateid", "type": "string" }, { - "description": "the public IP address for the router", - "name": "publicip", + "description": "the first IPv6 DNS for the router", + "name": "ip6dns1", "type": "string" }, { - "description": "VPC the router belongs to", - "name": "vpcid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "path of the Domain the router belongs to", - "name": "domainpath", + "description": "the name of the router", + "name": "name", "type": "string" }, { - "description": "the second DNS for the router", - "name": "dns2", - "type": "string" + "description": "the state of the router", + "name": "state", + "type": "state" }, - {}, { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", + "description": "the account associated with the router", + "name": "account", "type": "string" }, { - "description": "the account associated with the router", - "name": "account", + "description": "the version of template", + "name": "version", "type": "string" }, { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", + "description": "the second DNS for the router", + "name": "dns2", "type": "string" }, { @@ -110535,63 +110990,53 @@ "type": "string" }, { - "description": "the id of the router", - "name": "id", + "description": "the ID of the corresponding public network", + "name": "publicnetworkid", "type": "string" }, { - "description": "the state of the router", - "name": "state", - "type": "state" - }, - { - "description": "the domain ID associated with the router", - "name": "domainid", + "description": "the public netmask for the router", + "name": "publicnetmask", "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 Pod ID for the router", - "name": "podid", + "description": "the name of the corresponding guest network", + "name": "guestnetworkname", "type": "string" }, { - "description": "the Zone name for the router", - "name": "zonename", - "type": "string" + "description": "true if any health checks had failed", + "name": "healthchecksfailed", + "type": "boolean" }, { - "description": "the link local MAC address for the router", - "name": "linklocalmacaddress", + "description": "the host ID for the router", + "name": "hostid", "type": "string" }, { - "description": "the template name for the router", - "name": "templatename", + "description": "the Zone ID for the router", + "name": "zoneid", "type": "string" }, { - "description": "the guest IP address for the router", - "name": "guestipaddress", + "description": "role of the domain router", + "name": "role", "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 ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the guest MAC address for the router", + "name": "guestmacaddress", "type": "string" }, { @@ -110600,8 +111045,8 @@ "type": "string" }, { - "description": "the gateway for the router", - "name": "gateway", + "description": "the public MAC address for the router", + "name": "publicmacaddress", "type": "string" }, { @@ -110610,28 +111055,23 @@ "type": "string" }, { - "description": "role of the domain router", - "name": "role", + "description": "the control state of the host for the router", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the public IP address for the router", + "name": "publicip", "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 router", - "name": "podname", + "description": "the link local MAC address for the router", + "name": "linklocalmacaddress", "type": "string" }, { - "description": "the name of VPC the router belongs to", - "name": "vpcname", + "description": "the guest IP address for the router", + "name": "guestipaddress", "type": "string" }, { @@ -110640,200 +111080,116 @@ "type": "string" }, { - "description": "the ID of the corresponding public network", - "name": "publicnetworkid", + "description": "the name of VPC the router belongs to", + "name": "vpcname", "type": "string" }, { - "description": "the name of the corresponding guest network", - "name": "guestnetworkname", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the host ID for the router", - "name": "hostid", + "description": "the version of scripts", + "name": "scriptsversion", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "CPU arch of the router", + "name": "arch", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if the router template requires upgrader", + "name": "requiresupgrade", "type": "boolean" }, { - "description": "the template ID for the router", - "name": "templateid", - "type": "string" - }, - { - "description": "the list of nics associated with the router", - "name": "nic", + "description": "Last executed health check result for the router", + "name": "healthcheckresults", "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", + "description": "the type of the health check - basic or advanced", + "name": "checktype", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", + "description": "result of the health check if available", + "name": "success", "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", + "description": "detailed response generated on running health check", + "name": "details", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" + "description": "the date this VPC was created", + "name": "lastupdated", + "type": "date" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "the result of the health check in enum form: {SUCCESS, FAILURE, WARNING, UNKNOWN}", + "name": "status", + "type": "routerhealthstatus" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "the name of the health check on the router", + "name": "checkname", "type": "string" } ], - "type": "set" + "type": "list" }, { - "description": "the public netmask for the router", - "name": "publicnetmask", + "description": "the guest netmask for the router", + "name": "guestnetmask", + "type": "string" + }, + { + "description": "the date and time the router was created", + "name": "created", + "type": "date" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the domain ID associated with the router", + "name": "domainid", + "type": "string" + }, + { + "description": "the ID of the corresponding link local network", + "name": "linklocalnetworkid", + "type": "string" + }, + { + "description": "the Zone name for the router", + "name": "zonename", + "type": "string" + }, + { + "description": "the domain associated with the router", + "name": "domain", + "type": "string" + }, + { + "description": "the ID of the corresponding guest network", + "name": "guestnetworkid", + "type": "string" + }, + {}, + { + "description": "the Pod ID for the router", + "name": "podid", + "type": "string" + }, + { + "description": "the gateway for the router", + "name": "gateway", "type": "string" } ] @@ -110844,141 +111200,150 @@ "name": "listNics", "params": [ { - "description": "list nic of the specific vm's network", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "networkid", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", + "name": "fordisplay", "required": false, - "type": "uuid" + "since": "4.4", + "type": "boolean" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "the ID of the nic to list IPs", + "description": "", "length": 255, - "name": "nicid", - "related": "listNics", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { "description": "the ID of the vm", "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,createVMFromBackup,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "required": true, "type": "uuid" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "list nic of the specific vm's network", "length": 255, - "name": "fordisplay", + "name": "networkid", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", "required": false, - "since": "4.4", - "type": "boolean" + "type": "uuid" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "List by keyword", + "description": "the ID of the nic to list IPs", "length": 255, - "name": "keyword", + "name": "nicid", + "related": "listNics", "required": false, - "type": "string" + "type": "uuid" } ], "related": "", "response": [ { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, - {}, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, - {}, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", + "description": "MTU configured on the NIC", + "name": "mtu", "type": "integer" }, { - "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 vm to which the nic belongs", - "name": "virtualmachineid", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "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", + "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 isolation uri of the nic", - "name": "isolationuri", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { @@ -110987,83 +111352,74 @@ "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "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": "the cidr of IPv6 network", + "name": "ip6cidr", + "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": "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": "the type of the nic", - "name": "type", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "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", + "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": "MTU configured on the NIC", - "name": "mtu", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "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 gateway of IPv6 network", - "name": "ip6gateway", - "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 isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" } ] @@ -111074,40 +111430,33 @@ "name": "listCniConfiguration", "params": [ { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "isrecursive", + "name": "listall", "required": false, "type": "boolean" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", - "length": 255, - "name": "projectid", - "related": "", - "required": false, - "type": "uuid" - }, - { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "", "length": 255, - "name": "account", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "listall", + "name": "domainid", + "related": "createDomain,listDomains,listDomains", "required": false, - "type": "boolean" + "type": "uuid" }, { "description": "the ID of the Userdata", @@ -111118,10 +111467,17 @@ "type": "uuid" }, { - "description": "list only resources belonging to the domain specified", + "description": "List by keyword", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains", + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "", "required": false, "type": "uuid" }, @@ -111133,61 +111489,56 @@ "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": "", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "page", + "name": "account", "required": false, - "type": "integer" + "type": "string" } ], "related": "", "response": [ + {}, { "description": "ID of the User Data", "name": "id", "type": "string" }, { - "description": "the owner id of the User Data", - "name": "accountid", + "description": "the domain name of the User Data owner", + "name": "domain", "type": "string" }, - {}, { "description": "the domain id of the User Data owner", "name": "domainid", "type": "string" }, { - "description": "the project name of the User Data", - "name": "project", - "type": "string" - }, - { - "description": "the domain name of the User Data owner", - "name": "domain", + "description": "Name of the User Data", + "name": "name", "type": "string" }, { - "description": "base64 encoded User Data content", - "name": "userdata", + "description": "the project id of the User Data", + "name": "projectid", "type": "string" }, { - "description": "the owner of the User Data", - "name": "account", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "Name of the User Data", - "name": "name", + "description": "the owner id of the User Data", + "name": "accountid", "type": "string" }, { @@ -111196,30 +111547,35 @@ "type": "string" }, { - "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 the User Data", + "name": "params", + "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": "path of the domain to which the User Data owner belongs", + "name": "domainpath", + "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 owner of the User Data", + "name": "account", "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": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" } ], "since": "4.21.0" @@ -111230,71 +111586,71 @@ "name": "listBgpPeers", "params": [ { - "description": "the account which the Bgp Peer is dedicated to. 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 which the Bgp Peer is dedicated to.", + "description": "UUID of zone to which the Bgp Peer belongs to.", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains", + "name": "zoneid", + "related": "listZones", "required": false, "type": "uuid" }, { - "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": "AS number of the Bgp Peer.", "length": 255, - "name": "isdedicated", + "name": "asnumber", "required": false, - "type": "boolean" + "type": "long" }, { - "description": "project who which the Bgp Peer is dedicated to", + "description": "UUID of the Bgp Peer.", "length": 255, - "name": "projectid", - "related": "", + "name": "id", + "related": "listBgpPeers,releaseBgpPeer", "required": false, "type": "uuid" }, { - "description": "", + "description": "the account which the Bgp Peer is dedicated to. Must be used with the domainId parameter.", "length": 255, - "name": "page", + "name": "account", "required": false, - "type": "integer" + "type": "string" }, { - "description": "AS number of the Bgp Peer.", + "description": "", "length": 255, - "name": "asnumber", + "name": "page", "required": false, - "type": "long" + "type": "integer" }, { - "description": "UUID of zone to which the Bgp Peer belongs 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": "zoneid", - "related": "listZones", + "name": "isdedicated", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "UUID of the Bgp Peer.", + "description": "the domain ID which the Bgp Peer is dedicated to.", "length": 255, - "name": "id", - "related": "listBgpPeers,releaseBgpPeer", + "name": "domainid", + "related": "createDomain,listDomains,listDomains", "required": false, "type": "uuid" }, { - "description": "List by keyword", + "description": "project who which the Bgp Peer is dedicated to", "length": 255, - "name": "keyword", + "name": "projectid", + "related": "", "required": false, - "type": "string" + "type": "uuid" }, { "description": "", @@ -111307,33 +111663,34 @@ "related": "releaseBgpPeer", "response": [ { - "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 project id of the bgp peer", - "name": "projectid", + "description": "name of zone to which the bgp peer belongs to.", + "name": "zonename", "type": "string" }, { - "description": "the domain ID of the bgp peer", - "name": "domainid", + "description": "the project id of the bgp peer", + "name": "projectid", "type": "string" }, { - "description": "name of zone to which the bgp peer belongs to.", - "name": "zonename", - "type": "string" + "description": "additional key/value details of the bgp peer", + "name": "details", + "type": "map" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the account of the bgp peer", - "name": "account", + "description": "the domain ID of the bgp peer", + "name": "domainid", "type": "string" }, { @@ -111341,26 +111698,15 @@ "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" }, { @@ -111368,25 +111714,35 @@ "name": "password", "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" }, + { + "description": "IPv4 address of bgp peer", + "name": "ipaddress", + "type": "string" + }, { "description": "id of zone to which the bgp peer belongs to.", "name": "zoneid", "type": "string" }, + { + "description": "IPv6 address of bgp peer", + "name": "ip6address", + "type": "string" + }, { "description": "the domain name of the bgp peer", "name": "domain", "type": "string" + }, + { + "description": "the account of the bgp peer", + "name": "account", + "type": "string" } ], "since": "4.20.0" @@ -111396,14 +111752,6 @@ "isasync": true, "name": "createSnapshotFromVMSnapshot", "params": [ - { - "description": "The ID of the VM snapshot", - "length": 255, - "name": "vmsnapshotid", - "related": "listVMSnapshot,createVMSnapshot", - "required": true, - "type": "uuid" - }, { "description": "the name of the snapshot", "length": 255, @@ -111415,105 +111763,38 @@ "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", + "related": "importVolume,createVolume,updateVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", + "required": true, + "type": "uuid" + }, + { + "description": "The ID of the VM snapshot", + "length": 255, + "name": "vmsnapshotid", + "related": "listVMSnapshot,createVMSnapshot", "required": true, "type": "uuid" } ], "related": "copySnapshot,archiveSnapshot,listSnapshots", "response": [ - { - "description": "ID of the snapshot", - "name": "id", - "type": "string" - }, - { - "description": "type of the datastore for the snapshot entry", - "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", - "type": "string" - }, - { - "description": "name of the disk volume", - "name": "volumename", - "type": "string" - }, - { - "description": "the project id of the snapshot", - "name": "projectid", - "type": "string" - }, - { - "description": "physical size of backedup snapshot on image store", - "name": "physicalsize", - "type": "long" - }, - { - "description": "ID of the datastore for the snapshot entry", - "name": "datastoreid", - "type": "string" - }, - { - "description": "name of the datastore for the snapshot entry", - "name": "datastorename", - "type": "string" - }, - { - "description": "the account associated with the snapshot", - "name": "account", - "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", - "type": "string" - }, - { - "description": "valid location types are primary and secondary.", - "name": "locationtype", - "type": "string" - }, - { - "description": "ID of the disk volume", - "name": "volumeid", - "type": "string" - }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -111527,8 +111808,8 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -111541,24 +111822,19 @@ "name": "domain", "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", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -111569,19 +111845,20 @@ ], "type": "set" }, + {}, { - "description": "the domain name of the snapshot's account", - "name": "domain", + "description": "the project name of the snapshot", + "name": "project", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the account associated with the snapshot", + "name": "account", "type": "string" }, { - "description": "the status of the template", - "name": "status", + "description": "name of the snapshot", + "name": "name", "type": "string" }, { @@ -111591,13 +111868,53 @@ }, {}, { - "description": "indicates whether the underlying storage supports reverting the volume to this snapshot", - "name": "revertable", - "type": "boolean" + "description": "path of the Domain the snapshot's account belongs to", + "name": "domainpath", + "type": "string" }, { - "description": "state of the disk volume", - "name": "volumestate", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "display name of the os on volume", + "name": "osdisplayname", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "state of the snapshot on the datastore", + "name": "datastorestate", + "type": "string" + }, + { + "description": "valid types are hourly, daily, weekly, monthy, template, and none.", + "name": "intervaltype", + "type": "string" + }, + { + "description": "id of the os on volume", + "name": "ostypeid", + "type": "string" + }, + { + "description": "the type of the snapshot", + "name": "snapshottype", + "type": "string" + }, + { + "description": "ID of the disk volume", + "name": "volumeid", + "type": "string" + }, + { + "description": "id of the availability zone", + "name": "zoneid", "type": "string" }, { @@ -111605,56 +111922,95 @@ "name": "zonename", "type": "string" }, + { + "description": "ID of the snapshot", + "name": "id", + "type": "string" + }, + { + "description": "ID of the datastore for the snapshot entry", + "name": "datastoreid", + "type": "string" + }, + { + "description": "name of the datastore for the snapshot entry", + "name": "datastorename", + "type": "string" + }, { "description": "type of the disk volume", "name": "volumetype", "type": "string" }, { - "description": "path of the Domain the snapshot's account belongs to", - "name": "domainpath", + "description": "the domain ID of the snapshot's account", + "name": "domainid", "type": "string" }, - {}, { - "description": "id of the os on volume", - "name": "ostypeid", + "description": "type of the datastore for the snapshot entry", + "name": "datastoretype", "type": "string" }, { - "description": "name of the snapshot", - "name": "name", + "description": "download progress of a snapshot", + "name": "downloaddetails", + "type": "map" + }, + { + "description": "state of the disk volume", + "name": "volumestate", "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 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": "indicates whether the underlying storage supports reverting the volume to this snapshot", + "name": "revertable", + "type": "boolean" }, { - "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", + "type": "string" + }, + { + "description": "the domain name of the snapshot's account", + "name": "domain", + "type": "string" }, { - "description": "display name of the os on volume", - "name": "osdisplayname", + "description": "the status of the template", + "name": "status", "type": "string" }, { - "description": "id of the availability zone", - "name": "zoneid", + "description": "the project id of the snapshot", + "name": "projectid", "type": "string" }, { - "description": "state of the snapshot on the datastore", - "name": "datastorestate", + "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" } ], "since": "4.10.0" @@ -111665,11 +112021,11 @@ "name": "listImageStoreObjects", "params": [ { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { "description": "path to list on image store", @@ -111678,13 +112034,6 @@ "required": false, "type": "string" }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, { "description": "id of the image store", "length": 255, @@ -111693,6 +112042,13 @@ "required": true, "type": "uuid" }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, { "description": "", "length": 255, @@ -111704,13 +112060,28 @@ "related": "", "response": [ { - "description": "Snapshot Name associated with the data store object.", - "name": "snapshotname", + "description": "Name of the data store object.", + "name": "name", "type": "string" }, { - "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": "Template Name associated with the data store object.", + "name": "templatename", + "type": "string" + }, + { + "description": "Size is in Bytes.", + "name": "size", + "type": "long" + }, + { + "description": "Snapshot Name associated with the data store object.", + "name": "snapshotname", "type": "string" }, { @@ -111719,56 +112090,41 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "Last modified date of the file/directory.", + "name": "lastupdated", + "type": "date" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - { - "description": "Name of the data store object.", - "name": "name", - "type": "string" - }, { "description": "Is it a directory.", "name": "isdirectory", "type": "boolean" }, - {}, - { - "description": "Template Name associated with the data store object.", - "name": "templatename", - "type": "string" - }, { - "description": "Template ID associated with the data store object.", - "name": "templateid", + "description": "Snapshot ID associated with the data store object.", + "name": "snapshotid", "type": "string" }, {}, { - "description": "Format of template associated with the data store object.", - "name": "format", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Size is in Bytes.", - "name": "size", - "type": "long" - }, - { - "description": "Snapshot ID associated with the data store object.", - "name": "snapshotid", + "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" + "description": "Format of template associated with the data store object.", + "name": "format", + "type": "string" } ], "since": "4.19.0" @@ -111778,6 +112134,21 @@ "isasync": false, "name": "dedicateGuestVlanRange", "params": [ + { + "description": "physical network ID of the vlan", + "length": 255, + "name": "physicalnetworkid", + "related": "", + "required": true, + "type": "uuid" + }, + { + "description": "account who will own the VLAN", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, { "description": "domain ID of the account owning a VLAN", "length": 255, @@ -111794,56 +112165,29 @@ "required": false, "type": "uuid" }, - { - "description": "account who will own the VLAN", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, { "description": "guest vlan range to be dedicated", "length": 255, "name": "vlanrange", "required": true, "type": "string" - }, - { - "description": "physical network ID of the vlan", - "length": 255, - "name": "physicalnetworkid", - "related": "", - "required": true, - "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 zone of the guest vlan range", - "name": "zoneid", - "type": "long" + "description": "the project id of the guest vlan range", + "name": "projectid", + "type": "string" }, { - "description": "the ID of the guest VLAN range", - "name": "id", + "description": "the domain ID of the guest VLAN range", + "name": "domainid", "type": "string" }, { @@ -111852,23 +112196,23 @@ "type": "string" }, { - "description": "the account of the guest VLAN range", - "name": "account", + "description": "the ID of the guest VLAN range", + "name": "id", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the guest VLAN range", + "name": "guestvlanrange", "type": "string" }, { - "description": "the domain ID of the guest VLAN range", - "name": "domainid", - "type": "string" + "description": "the physical network of the guest vlan range", + "name": "physicalnetworkid", + "type": "long" }, { - "description": "the guest VLAN range", - "name": "guestvlanrange", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -111876,11 +112220,23 @@ "name": "project", "type": "string" }, + {}, { - "description": "the project id of the guest vlan range", - "name": "projectid", + "description": "the zone of the guest vlan range", + "name": "zoneid", + "type": "long" + }, + { + "description": "the account of the guest VLAN range", + "name": "account", "type": "string" - } + }, + { + "description": "path of the domain to which the guest VLAN range belongs", + "name": "domainpath", + "type": "string" + }, + {} ] }, { @@ -111889,41 +112245,48 @@ "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": "true if the template type is routing i.e., if template is used to deploy router", "length": 255, - "name": "cleanupdetails", + "name": "isrouting", "required": false, "type": "boolean" }, { - "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": "Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", "length": 255, - "name": "bootable", + "name": "details", "required": false, - "type": "boolean" + "type": "map" }, { - "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", + "description": "the name of the image file", "length": 255, - "name": "arch", + "name": "name", "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": "the display text of the image", "length": 4096, @@ -111932,32 +112295,25 @@ "type": "string" }, { - "description": "true if the template type is routing i.e., if template is used to deploy router", + "description": "the ID of the image file", "length": 255, - "name": "isrouting", - "required": false, - "type": "boolean" + "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" }, { - "description": "true if the template supports the sshkey upload feature; default is false", + "description": "true if the image supports the password reset feature; default is false", "length": 255, - "name": "sshkeyenabled", + "name": "passwordenabled", "required": false, "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 requires HVM, false otherwise; available only for updateTemplate API", "length": 255, - "name": "forceupdateostype", + "name": "requireshvm", "required": false, - "since": "4.21", "type": "boolean" }, { @@ -111976,87 +112332,93 @@ "type": "string" }, { - "description": "the ID of the image file", + "description": "true if the template supports the sshkey upload feature; default is false", "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" + "name": "sshkeyenabled", + "required": false, + "type": "boolean" }, { - "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": "Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", + "description": "sort key of the template, integer", "length": 255, - "name": "details", + "name": "sortkey", "required": false, - "type": "map" + "type": "integer" }, { - "description": "the name of the image file", + "description": "the CPU arch of the template/ISO. Valid options are: x86_64, aarch64", "length": 255, - "name": "name", + "name": "arch", "required": false, + "since": "4.20", "type": "string" } ], - "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", "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": "path of the Domain the template belongs to", + "name": "domainpath", + "type": "string" }, { - "description": "the date this template was created", - "name": "created", - "type": "date" + "description": "the template name", + "name": "name", + "type": "string" }, { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", - "type": "boolean" + "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": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", - "type": "set" + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", + "type": "boolean" }, {}, { - "description": "the type of the template", - "name": "templatetype", + "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": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" }, { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", - "type": "boolean" + "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", + "name": "userdataparams", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "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 project name of the template", @@ -112064,50 +112426,49 @@ "type": "string" }, { - "description": "the name of the OS type for this template.", - "name": "ostypename", - "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": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" }, { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" + "description": "the template ID", + "name": "id", + "type": "string" }, - {}, { - "description": "the id of userdata linked to this template", - "name": "userdataid", + "description": "the ID of the domain to which the template belongs", + "name": "domainid", "type": "string" }, { - "description": "the project id of the template", - "name": "projectid", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "the processor bit size", - "name": "bits", - "type": "int" + "description": "The name of extension linked to this template", + "name": "extensionname", + "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 userdata linked to this template", + "name": "userdataname", "type": "string" }, { - "description": "path of the Domain the template belongs to", - "name": "domainpath", - "type": "string" + "description": "the physical size of the template", + "name": "physicalsize", + "type": "long" }, { "description": "true if the reset password feature is enabled, false otherwise", @@ -112115,29 +112476,39 @@ "type": "boolean" }, { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", + "description": "the date this template was removed", + "name": "removed", + "type": "date" + }, + { + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "name": "isdynamicallyscalable", "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the tag of this template", + "name": "templatetag", "type": "string" }, { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", + "description": "the size of the template", + "name": "size", + "type": "long" + }, + { + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", "type": "boolean" }, { - "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 ID of the zone for this template", + "name": "zoneid", + "type": "string" }, { "description": "the account name to which the template belongs", @@ -112145,18 +112516,44 @@ "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": "checksum of the template", - "name": "checksum", + "description": "The ID of extension linked to this template", + "name": "extensionid", "type": "string" }, { - "description": "the name of the secondary storage host for the template", - "name": "hostname", + "description": "the 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 format of the template.", + "name": "format", + "type": "imageformat" + }, + { + "description": "If true it indicates that the template can be used for CKS cluster deployments", + "name": "forcks", + "type": "boolean" + }, + {}, + { + "description": "the id of userdata linked to this template", + "name": "userdataid", + "type": "string" + }, + { + "description": "the project id of the template", + "name": "projectid", "type": "string" }, { @@ -112165,198 +112562,157 @@ "type": "list" }, { - "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 name of userdata linked to this template", - "name": "userdataname", + "description": "the template display text", + "name": "displaytext", "type": "string" }, { - "description": "The ID of extension linked to this template", - "name": "extensionid", + "description": "the type of the template", + "name": "templatetype", "type": "string" }, { - "description": "the tag of this template", - "name": "templatetag", + "description": "the URL which the template/iso is registered from", + "name": "url", "type": "string" }, { - "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": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the name of the domain to which the template belongs", + "name": "domain", "type": "string" }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", + "description": "the status of the template", + "name": "status", "type": "string" }, { - "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 name of the zone for this template", - "name": "zonename", + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" + }, + { + "description": "the date this template was created", + "name": "created", + "type": "date" + }, + { + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", + "type": "boolean" + }, + { + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", + "type": "boolean" + }, + { + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", + "type": "boolean" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + { + "description": "the processor bit size", + "name": "bits", + "type": "int" + }, { "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", "name": "directdownload", "type": "boolean" }, { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "the name of the zone for this template", + "name": "zonename", + "type": "string" }, { "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 managed across all Zones, false otherwise", - "name": "crossZones", - "type": "boolean" - }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "id of the resource", + "name": "resourceid", "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": "resource type", - "name": "resourcetype", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "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": "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": "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": "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 name of the domain to which the template belongs", - "name": "domain", - "type": "string" - }, - { - "description": "the template display text", - "name": "displaytext", - "type": "string" - }, - { - "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": "the ID of the secondary storage host for the template", - "name": "hostid", - "type": "string" - }, - { - "description": "the ID of the zone for this template", - "name": "zoneid", - "type": "string" - }, - { - "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", - "name": "userdataparams", - "type": "string" - }, - { - "description": "the template name", - "name": "name", - "type": "string" - }, - { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", - "type": "string" - }, - { - "description": "the account id to which the template belongs", - "name": "accountid", - "type": "string" - }, - { - "description": "the URL which the template/iso is registered from", - "name": "url", - "type": "string" - }, - { - "description": "The name of extension linked to this template", - "name": "extensionname", - "type": "string" - }, - {}, - { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", - "type": "string" - }, { "description": "CPU Arch of the template", "name": "arch", @@ -112379,28 +112735,28 @@ } ], "response": [ + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, {}, - {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - } + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {} ] }, { @@ -112408,6 +112764,13 @@ "isasync": true, "name": "issueCertificate", "params": [ + { + "description": "The certificate signing request (in pem format), if CSR is not provided then configured/provided options are considered", + "length": 65535, + "name": "csr", + "required": false, + "type": "string" + }, { "description": "Comma separated list of IP addresses, the certificate should be issued for", "length": 255, @@ -112416,9 +112779,9 @@ "type": "string" }, { - "description": "The certificate signing request (in pem format), if CSR is not provided then configured/provided options are considered", - "length": 65535, - "name": "csr", + "description": "Comma separated list of domains, the certificate should be issued for. When csr is not provided, the first domain is used as a subject/CN", + "length": 255, + "name": "domain", "required": false, "type": "string" }, @@ -112435,43 +112798,36 @@ "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": "Private key for the certificate", + "name": "privatekey", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "The client certificate", "name": "certificate", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - { - "description": "Private key for the certificate", - "name": "privatekey", - "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" - }, {} ], "since": "4.11.0" @@ -112482,41 +112838,34 @@ "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 private port range", "length": 255, - "name": "openfirewall", - "required": false, - "type": "boolean" + "name": "privateport", + "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", - "length": 255, - "name": "vmguestip", - "required": false, - "type": "string" - }, { "description": "the ID of the virtual machine for the port forwarding rule", "length": 255, "name": "virtualmachineid", - "related": "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,createVMFromBackup,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "required": true, "type": "uuid" }, { - "description": "the protocol for the port forwarding rule. Valid values are TCP or UDP.", + "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": "protocol", - "required": true, - "type": "string" + "name": "cidrlist", + "required": false, + "type": "list" }, { "description": "the ending port of port forwarding rule's private port range", @@ -112533,18 +112882,19 @@ "type": "integer" }, { - "description": "the starting port of port forwarding rule's private port range", + "description": "the protocol for the port forwarding rule. Valid values are TCP or UDP.", "length": 255, - "name": "privateport", + "name": "protocol", "required": true, - "type": "integer" + "type": "string" }, { - "description": "the 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", @@ -112555,61 +112905,32 @@ "type": "boolean" }, { - "description": " the source CIDR list to allow traffic from; all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,). This param will be used only for VPC tiers. By default, all CIDRs are allowed.", + "description": "VM guest nic secondary IP address for the port forwarding rule", "length": 255, - "name": "cidrlist", + "name": "vmguestip", "required": false, - "type": "list" + "type": "string" }, { - "description": "the IP address id of the port forwarding rule", + "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": "ipaddressid", - "related": "associateIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "name": "openfirewall", + "required": false, + "type": "boolean" + }, + { + "description": "the starting port of port forwarding rule's public port range", + "length": 255, + "name": "publicport", "required": true, - "type": "uuid" + "type": "integer" } ], "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", + "description": "the VM ID for the port forwarding rule", + "name": "virtualmachineid", "type": "string" }, { @@ -112617,18 +112938,18 @@ "name": "tags", "response": [ { - "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": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -112637,23 +112958,23 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "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": "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 domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -112667,8 +112988,8 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], @@ -112680,13 +113001,14 @@ "type": "integer" }, { - "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 VM ID for the port forwarding rule", - "name": "virtualmachineid", + "description": "the public ip address id for the port forwarding rule", + "name": "ipaddressid", "type": "string" }, { @@ -112694,6 +113016,41 @@ "name": "state", "type": "string" }, + { + "description": "the vm ip address for the port forwarding rule", + "name": "vmguestip", + "type": "string" + }, + { + "description": "the VM name for the port forwarding rule", + "name": "virtualmachinename", + "type": "string" + }, + { + "description": "the starting port of port forwarding rule's public port range", + "name": "publicport", + "type": "string" + }, + { + "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 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 starting port of port forwarding rule's private port range", "name": "privateport", @@ -112704,53 +113061,51 @@ "name": "virtualmachinedisplayname", "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", + "description": "the ID of the port forwarding rule", + "name": "id", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the id of the guest network the port forwarding rule belongs to", + "name": "networkid", "type": "string" }, { - "description": "the public ip address for the port forwarding rule", - "name": "ipaddress", + "description": "the protocol of the port forwarding rule", + "name": "protocol", "type": "string" - } + }, + {} ] }, { - "description": "load template into primary storage", - "isasync": false, - "name": "prepareTemplate", + "description": "Dedicates a zones.", + "isasync": true, + "name": "dedicateZone", "params": [ { - "description": "template ID of the template to be prepared in primary storage(s).", + "description": "the ID of the containing domain", "length": 255, - "name": "templateid", - "related": "prepareTemplate,listIsos,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "name": "domainid", + "related": "createDomain,listDomains,listDomains", "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.", + "description": "the name of the account which needs dedication. Must be used with domainId.", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "zone ID of the template to be prepared in primary storage(s).", + "description": "the ID of the zone", "length": 255, "name": "zoneid", "related": "listZones", @@ -112758,153 +113113,112 @@ "type": "uuid" } ], - "related": "listIsos,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "related": "", "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", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the account name to which the template belongs", - "name": "account", + "description": "the Account Id to which the Zone is dedicated", + "name": "accountid", "type": "string" }, + {}, { - "description": "the name of the secondary storage host for the template", - "name": "hostname", + "description": "the ID of the dedicated resource", + "name": "id", "type": "string" }, { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" - }, - { - "description": "the ID of the zone for this template", + "description": "the ID of the Zone", "name": "zoneid", "type": "string" }, { - "description": "CPU Arch of the template", - "name": "arch", - "type": "string" - }, - { - "description": "the list of resource tags associated", - "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": "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": "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 account associated with the tag", - "name": "account", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", - "type": "string" - }, - { - "description": "the account id to which the template belongs", - "name": "accountid", + "description": "the domain ID to which the Zone is dedicated", + "name": "domainid", "type": "string" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the template display text", - "name": "displaytext", + "description": "the Dedication Affinity Group ID of the zone", + "name": "affinitygroupid", "type": "string" }, { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", + "description": "the Name of the Zone", + "name": "zonename", "type": "string" + } + ] + }, + { + "description": "load template into primary storage", + "isasync": false, + "name": "prepareTemplate", + "params": [ + { + "description": "template ID of the template to be prepared in primary storage(s).", + "length": 255, + "name": "templateid", + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "required": true, + "type": "uuid" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "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": "the template name", - "name": "name", - "type": "string" + "description": "zone ID of the template to be prepared in primary storage(s).", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" + } + ], + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,listIsos,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "response": [ + { + "description": "the processor bit size", + "name": "bits", + "type": "int" }, { - "description": "the physical size of the template", - "name": "physicalsize", - "type": "long" + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", + "type": "boolean" }, { - "description": "path of the Domain the template belongs to", - "name": "domainpath", + "description": "the ID of the zone for this template", + "name": "zoneid", "type": "string" }, { - "description": "If true it indicates that the template can be used for CKS cluster deployments", - "name": "forcks", - "type": "boolean" + "description": "CPU Arch of the template", + "name": "arch", + "type": "string" }, { - "description": "the URL which the template/iso is registered from", - "name": "url", + "description": "the date this template was removed", + "name": "removed", + "type": "date" + }, + { + "description": "checksum of the template", + "name": "checksum", "type": "string" }, { @@ -112913,14 +113227,25 @@ "type": "imageformat" }, { - "description": "the name of the OS type for this template.", - "name": "ostypename", + "description": "the tag of this template", + "name": "templatetag", "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 URL which the template/iso is registered from", + "name": "url", + "type": "string" + }, + {}, + { + "description": "the template name", + "name": "name", + "type": "string" }, { "description": "the size of the template", @@ -112928,38 +113253,38 @@ "type": "long" }, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "the account id to which the template belongs", + "name": "accountid", + "type": "string" }, { - "description": "the name of userdata linked to this template", - "name": "userdataname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" + "description": "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": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" }, { - "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 ID of the domain to which the template belongs", + "name": "domainid", "type": "string" }, { @@ -112968,54 +113293,110 @@ "type": "string" }, { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "the account name to which the template belongs", + "name": "account", + "type": "string" }, { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" + "description": "the template display text", + "name": "displaytext", + "type": "string" }, { - "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": "true if the ISO is bootable, false otherwise", - "name": "bootable", + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", "type": "boolean" }, - {}, { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "the name of the OS type for this template.", + "name": "ostypename", + "type": "string" }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", + "description": "The ID of extension linked to this template", + "name": "extensionid", "type": "string" }, { - "description": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "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": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "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 ID of extension linked to this template", - "name": "extensionid", - "type": "string" + "description": "the date this template was created", + "name": "created", + "type": "date" }, { - "description": "The name of extension linked to this template", - "name": "extensionname", + "description": "the id of userdata linked to this template", + "name": "userdataid", "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" }, { @@ -113024,29 +113405,30 @@ "type": "boolean" }, { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "name": "isdynamicallyscalable", "type": "boolean" }, { - "description": "checksum of the template", - "name": "checksum", + "description": "the name of userdata linked to this template", + "name": "userdataname", "type": "string" }, + {}, { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", - "type": "string" + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" }, { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", - "type": "boolean" + "description": "The name of extension linked to this template", + "name": "extensionname", + "type": "string" }, { - "description": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", - "type": "map" + "description": "the template ID", + "name": "id", + "type": "string" }, { "description": "the name of the zone for this template", @@ -113054,141 +113436,115 @@ "type": "string" }, { - "description": "the processor bit size", - "name": "bits", - "type": "int" - }, - { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", "type": "boolean" }, - { - "description": "the date this template was removed", - "name": "removed", - "type": "date" - }, - {}, { "description": "the name of the domain to which the template belongs", "name": "domain", "type": "string" }, { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", - "type": "boolean" + "description": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the project name of the template", + "name": "project", "type": "string" }, { - "description": "the project id of the template", - "name": "projectid", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the tag of this template", - "name": "templatetag", - "type": "string" + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", + "type": "boolean" }, { - "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", - "type": "boolean" - }, { - "description": "the id of userdata linked to this template", - "name": "userdataid", + "description": "the name of the secondary storage host for the template", + "name": "hostname", "type": "string" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - } - ] - }, - { - "description": "Dedicates a zones.", - "isasync": true, - "name": "dedicateZone", - "params": [ - { - "description": "the ID of the containing domain", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains", - "required": true, - "type": "uuid" }, { - "description": "the ID of the zone", - "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, - "type": "uuid" + "description": "the type of the template", + "name": "templatetype", + "type": "string" }, { - "description": "the name of the account which needs dedication. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" - } - ], - "related": "", - "response": [ - {}, + }, { - "description": "the Name of the Zone", - "name": "zonename", + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", "type": "string" }, { - "description": "the ID of the dedicated resource", - "name": "id", + "description": "the ID of the OS type for this template.", + "name": "ostypeid", "type": "string" }, { - "description": "the domain ID to which the Zone is dedicated", - "name": "domainid", + "description": "the project id of the template", + "name": "projectid", "type": "string" }, { - "description": "the Account Id to which the Zone is dedicated", - "name": "accountid", - "type": "string" + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", + "type": "boolean" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the secondary storage host for the template", + "name": "hostid", "type": "string" }, { - "description": "the Dedication Affinity Group ID of the zone", - "name": "affinitygroupid", + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", "type": "string" }, { - "description": "the ID of the Zone", - "name": "zoneid", + "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 managed across all Zones, false otherwise", + "name": "crossZones", + "type": "boolean" + }, + { + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", + "type": "boolean" + }, + { + "description": "path of the Domain the template belongs to", + "name": "domainpath", "type": "string" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the physical size of the template", + "name": "physicalsize", + "type": "long" } ] }, @@ -113197,13 +113553,6 @@ "isasync": false, "name": "updateBackupOffering", "params": [ - { - "description": "The name of the Backup Offering to be updated", - "length": 255, - "name": "name", - "required": false, - "type": "string" - }, { "description": "The description of the Backup Offering to be updated", "length": 255, @@ -113219,6 +113568,13 @@ "required": true, "type": "uuid" }, + { + "description": "The name of the Backup Offering to be updated", + "length": 255, + "name": "name", + "required": false, + "type": "string" + }, { "description": "Whether to allow user driven backups or not", "length": 255, @@ -113230,42 +113586,31 @@ "related": "", "response": [ { - "description": "zone ID", - "name": "zoneid", - "type": "string" - }, - {}, - { - "description": "the date this backup offering was created", - "name": "created", - "type": "date" + "description": "whether offering allows user driven ad-hoc/scheduled backups", + "name": "allowuserdrivenbackups", + "type": "boolean" }, - {}, { "description": "name for the backup offering", "name": "name", "type": "string" }, { - "description": "whether offering allows user driven ad-hoc/scheduled backups", - "name": "allowuserdrivenbackups", - "type": "boolean" + "description": "the date this backup offering was created", + "name": "created", + "type": "date" }, { - "description": "provider name", - "name": "provider", + "description": "zone ID", + "name": "zoneid", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "ID of the backup offering", "name": "id", "type": "string" }, + {}, { "description": "external ID on the provider side", "name": "externalid", @@ -113276,14 +113621,30 @@ "name": "description", "type": "string" }, + { + "description": "the backups with this offering can be used to create Instances on all Zones", + "name": "crosszoneinstancecreation", + "type": "boolean" + }, + {}, + { + "description": "zone name", + "name": "zonename", + "type": "string" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "zone name", - "name": "zonename", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "provider name", + "name": "provider", "type": "string" } ], @@ -113302,6 +113663,13 @@ "required": false, "type": "uuid" }, + { + "description": "List resources by tags (key/value pairs)", + "length": 255, + "name": "tags", + "required": false, + "type": "map" + }, { "description": "List by keyword", "length": 255, @@ -113310,12 +113678,11 @@ "type": "string" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "the name of the bucket", "length": 255, - "name": "projectid", - "related": "", + "name": "name", "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.", @@ -113325,48 +113692,50 @@ "type": "boolean" }, { - "description": "the name of the bucket", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "name", + "name": "projectid", + "related": "", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the IDs of the Buckets, mutually exclusive with id", + "description": "the ID of the object storage pool, available to ROOT admin only", "length": 255, - "name": "ids", - "related": "listBuckets", + "name": "objectstorageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", "required": false, - "type": "list" + "type": "uuid" }, { - "description": "List resources by tags (key/value pairs)", + "description": "the ID of the bucket", "length": 255, - "name": "tags", + "name": "id", + "related": "listBuckets", "required": false, - "type": "map" + "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 IDs of the Buckets, mutually exclusive with id", "length": 255, - "name": "account", + "name": "ids", + "related": "listBuckets", "required": false, - "type": "string" + "type": "list" }, { - "description": "the ID of the object storage pool, available to ROOT admin only", + "description": "", "length": 255, - "name": "objectstorageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", + "name": "pagesize", "required": false, - "type": "uuid" + "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.", @@ -113376,37 +113745,85 @@ "type": "boolean" }, { - "description": "the ID of the bucket", - "length": 255, - "name": "id", - "related": "listBuckets", - "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" } ], "related": "", "response": [ { - "description": "the project name of the bucket", - "name": "project", - "type": "string" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "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": "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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project name of the bucket", + "name": "project", "type": "string" }, - {}, { - "description": "id of the object storage hosting the Bucket; returned to admin user only", - "name": "objectstorageid", + "description": "Bucket Access Policy", + "name": "policy", "type": "string" }, { @@ -113415,14 +113832,19 @@ "type": "string" }, { - "description": "path of the domain to which the bucket belongs", - "name": "domainpath", + "description": "the domain associated with the bucket", + "name": "domain", "type": "string" }, { - "description": "Bucket Access Policy", - "name": "policy", - "type": "string" + "description": "Bucket Object Locking", + "name": "objectlocking", + "type": "boolean" + }, + { + "description": "Bucket Versioning", + "name": "versioning", + "type": "boolean" }, { "description": "State of the Bucket", @@ -113430,40 +113852,40 @@ "type": "string" }, { - "description": "name of the Bucket", - "name": "name", + "description": "Bucket Access Key", + "name": "accesskey", "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 Bucket", + "name": "account", + "type": "string" }, { - "description": "Bucket Secret Key", - "name": "usersecretkey", + "description": "name of the Bucket", + "name": "name", "type": "string" }, { - "description": "Object storage provider", - "name": "provider", + "description": "id of the object storage hosting the Bucket; returned to admin user only", + "name": "objectstorageid", "type": "string" }, { - "description": "Bucket Object Locking", - "name": "objectlocking", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "ID of the Bucket", - "name": "id", + "description": "the project id of the bucket", + "name": "projectid", "type": "string" }, - {}, { - "description": "Name of the object storage hosting the Bucket; returned to admin user only", - "name": "objectstore", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { "description": "Bucket Encryption", @@ -113471,8 +113893,14 @@ "type": "boolean" }, { - "description": "the account associated with the Bucket", - "name": "account", + "description": "ID of the Bucket", + "name": "id", + "type": "string" + }, + {}, + { + "description": "path of the domain to which the bucket belongs", + "name": "domainpath", "type": "string" }, { @@ -113481,34 +113909,29 @@ "type": "string" }, { - "description": "Bucket Access Key", - "name": "accesskey", + "description": "Object storage provider", + "name": "provider", "type": "string" }, { - "description": "the project id of the bucket", - "name": "projectid", + "description": "Bucket Secret Key", + "name": "usersecretkey", "type": "string" }, { - "description": "Bucket Quota in GiB", - "name": "quota", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, - { - "description": "the domain associated with the bucket", - "name": "domain", - "type": "string" - }, { "description": "the date the Bucket was created", "name": "created", "type": "date" }, { - "description": "Bucket Versioning", - "name": "versioning", - "type": "boolean" + "description": "Name of the object storage hosting the Bucket; returned to admin user only", + "name": "objectstore", + "type": "string" }, { "description": "Total size of objects in Bucket", @@ -113516,71 +113939,9 @@ "type": "long" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "Bucket Quota in GiB", + "name": "quota", + "type": "integer" } ], "since": "4.19.0" @@ -113590,6 +113951,13 @@ "isasync": true, "name": "stopInternalLoadBalancerVM", "params": [ + { + "description": "Force stop the VM (vm is marked as Stopped even when command fails to be send to the backend, otherwise a force poweroff is attempted). To be used if the caller knows the VM is stopped and should be marked as such.", + "length": 255, + "name": "forced", + "required": false, + "type": "boolean" + }, { "description": "the ID of the internal lb vm", "length": 255, @@ -113597,20 +113965,58 @@ "related": "listRouters,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs", "required": true, "type": "uuid" - }, - { - "description": "Force stop the VM (vm is marked as Stopped even when command fails to be send to the backend, otherwise a force poweroff is attempted). To be used if the caller knows the VM is stopped and should be marked as such.", - "length": 255, - "name": "forced", - "required": false, - "type": "boolean" } ], "related": "listRouters,changeServiceForRouter,listInternalLoadBalancerVMs", "response": [ { - "description": "the gateway for the router", - "name": "gateway", + "description": "the Pod name for the router", + "name": "podname", + "type": "string" + }, + { + "description": "the version of template", + "name": "version", + "type": "string" + }, + { + "description": "the version of the code / software in the router", + "name": "softwareversion", + "type": "string" + }, + { + "description": "the control state of the host for the router", + "name": "hostcontrolstate", + "type": "string" + }, + { + "description": "the account associated with the router", + "name": "account", + "type": "string" + }, + { + "description": "the state of redundant virtual router", + "name": "redundantstate", + "type": "string" + }, + { + "description": "the template name for the router", + "name": "templatename", + "type": "string" + }, + { + "description": "the project id of the ipaddress", + "name": "projectid", + "type": "string" + }, + { + "description": "VPC the router belongs to", + "name": "vpcid", + "type": "string" + }, + { + "description": "CPU arch of the router", + "name": "arch", "type": "string" }, { @@ -113619,45 +114025,43 @@ "type": "string" }, { - "description": "the public netmask for the router", - "name": "publicnetmask", + "description": "the domain ID associated with the router", + "name": "domainid", "type": "string" }, { - "description": "the name of VPC the router belongs to", - "name": "vpcname", - "type": "string" + "description": "true if any health checks had failed", + "name": "healthchecksfailed", + "type": "boolean" }, { - "description": "the name of the router", - "name": "name", + "description": "the Zone name for the router", + "name": "zonename", "type": "string" }, { - "description": "the id of the router", - "name": "id", + "description": "the ID of the corresponding public network", + "name": "publicnetworkid", "type": "string" }, - {}, { - "description": "the version of scripts", - "name": "scriptsversion", + "description": "the guest IP address for the router", + "name": "guestipaddress", "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "the public MAC address for the router", + "name": "publicmacaddress", "type": "string" }, - {}, { - "description": "if this router is an redundant virtual router", - "name": "isredundantrouter", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the first DNS for the router", - "name": "dns1", + "description": "the gateway for the router", + "name": "gateway", "type": "string" }, { @@ -113666,59 +114070,125 @@ "type": "string" }, { - "description": "the link local IP address for the router", - "name": "linklocalip", + "description": "the second IPv6 DNS for the router", + "name": "ip6dns2", "type": "string" }, { - "description": "the domain associated with the router", - "name": "domain", + "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": "the first IPv6 DNS for the router", + "name": "ip6dns1", "type": "string" }, { - "description": "the hostname for the router", - "name": "hostname", + "description": "the Pod ID for the router", + "name": "podid", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "if this router is an redundant virtual router", + "name": "isredundantrouter", + "type": "boolean" + }, + { + "description": "the template ID for the router", + "name": "templateid", "type": "string" }, { - "description": "CPU arch of the router", - "name": "arch", + "description": "the Zone ID for the router", + "name": "zoneid", + "type": "string" + }, + { + "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": "true if the router template requires upgrader", + "name": "requiresupgrade", + "type": "boolean" + }, + { + "description": "role of the domain router", + "name": "role", + "type": "string" + }, + { + "description": "the network domain for the router", + "name": "networkdomain", + "type": "string" + }, + { + "description": "the hostname for the router", + "name": "hostname", + "type": "string" + }, + { + "description": "the guest netmask for the router", + "name": "guestnetmask", "type": "string" }, + {}, { "description": "the state of the router", "name": "state", "type": "state" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the second DNS for the router", + "name": "dns2", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the domain associated with the router", + "name": "domain", + "type": "string" + }, + { + "description": "the name of the router", + "name": "name", + "type": "string" + }, + { + "description": "the public IP address for the router", + "name": "publicip", + "type": "string" }, { "description": "Last executed health check result for the router", "name": "healthcheckresults", "response": [ { - "description": "result of the health check", + "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 name of the health check on the router", + "name": "checkname", + "type": "string" + }, { "description": "detailed response generated on running health check", "name": "details", @@ -113728,58 +114198,33 @@ "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": "role of the domain router", - "name": "role", - "type": "string" - }, - { - "description": "the guest IP address for the router", - "name": "guestipaddress", - "type": "string" - }, - { - "description": "the ID of the corresponding public network", - "name": "publicnetworkid", - "type": "string" - }, - { - "description": "the template name for the router", - "name": "templatename", + "description": "the first DNS for the router", + "name": "dns1", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the guest MAC address for the router", - "name": "guestmacaddress", + "description": "the link local MAC address for the router", + "name": "linklocalmacaddress", "type": "string" }, { - "description": "path of the Domain the router belongs to", - "name": "domainpath", + "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", + "description": "the link local IP address for the router", + "name": "linklocalip", "type": "string" }, { @@ -113788,34 +114233,14 @@ "type": "string" }, { - "description": "the version of template", - "name": "version", - "type": "string" - }, - { - "description": "the Zone ID for the router", - "name": "zoneid", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the control state of the host for the router", - "name": "hostcontrolstate", + "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" - }, - { - "description": "the Pod name for the router", - "name": "podname", - "type": "string" + "description": "the date and time the router was created", + "name": "created", + "type": "date" }, { "description": "the name of the corresponding guest network", @@ -113823,13 +114248,13 @@ "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 public MAC address for the router", - "name": "publicmacaddress", + "description": "the ID of the corresponding link local network", + "name": "linklocalnetworkid", "type": "string" }, { @@ -113841,34 +114266,44 @@ "name": "nsxlogicalswitch", "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 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": "the ID of the nic", - "name": "id", + "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 corresponding network", + "name": "networkid", + "type": "string" }, { - "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", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { @@ -113877,23 +114312,18 @@ "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 isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "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" }, { - "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" }, { @@ -113902,8 +114332,8 @@ "type": "list" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { @@ -113912,58 +114342,58 @@ "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the type of the nic", + "name": "type", "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 type of the nic", - "name": "type", - "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 traffic type of the nic", + "name": "traffictype", + "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "Id of the NSX Logical Switch 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" }, { @@ -113972,120 +114402,219 @@ "type": "list" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" } ], "type": "set" }, { - "description": "the network domain for the router", - "name": "networkdomain", + "description": "path of the Domain the router belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the second DNS for the router", - "name": "dns2", + "description": "the id of the router", + "name": "id", "type": "string" }, { - "description": "the domain ID associated with the router", - "name": "domainid", + "description": "the version of scripts", + "name": "scriptsversion", "type": "string" }, + {}, { - "description": "true if any health checks had failed", - "name": "healthchecksfailed", - "type": "boolean" + "description": "the public netmask for the router", + "name": "publicnetmask", + "type": "string" }, { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" + } + ] + }, + { + "description": "Creates a GPU device manually on a host", + "isasync": false, + "name": "createGpuDevice", + "params": [ + { + "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 guest netmask for the router", - "name": "guestnetmask", + "description": "ID of the GPU card type", + "length": 255, + "name": "gpucardid", + "related": "", + "required": true, + "type": "uuid" + }, + { + "description": "ID of the host where the GPU device is located", + "length": 255, + "name": "hostid", + "related": "declareHostAsDegraded,reconnectHost", + "required": true, + "type": "uuid" + }, + { + "description": "Type of GPU device (PCI, MDEV, VGPUOnly). Defaults to PCI.", + "length": 255, + "name": "type", + "required": false, "type": "string" }, { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", + "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 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" + }, + { + "description": "ID of the vGPU profile", + "length": 255, + "name": "vgpuprofileid", + "related": "", + "required": true, + "type": "uuid" + } + ], + "related": "listGpuDevices,discoverGpuDevices", + "response": [ + { + "description": "the vGPU profile ID assigned to this GPU device", + "name": "virtualmachineid", "type": "string" }, { - "description": "the state of redundant virtual router", - "name": "redundantstate", + "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 host ID for the router", - "name": "hostid", + "description": "the vGPU profile name assigned to this GPU device", + "name": "virtualmachinename", "type": "string" }, { - "description": "the public IP address for the router", - "name": "publicip", + "description": "the GPU card ID associated with this GPU device", + "name": "gpucardid", "type": "string" }, { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", + "description": "the vGPU profile name assigned to this GPU device", + "name": "vgpuprofilename", "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 ID of the GPU device", + "name": "id", "type": "string" }, { - "description": "true if the router template requires upgrader", - "name": "requiresupgrade", - "type": "boolean" + "description": "the host ID where the GPU device is attached", + "name": "hostid", + "type": "string" }, { - "description": "the Zone name for the router", - "name": "zonename", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "bus address of the GPU device", + "name": "gpudevicetype", + "type": "devicetype" + }, + { + "description": "the vGPU profile ID assigned to this GPU device", + "name": "vgpuprofileid", "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 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 UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the host name where the GPU device is attached", + "name": "hostname", + "type": "string" + }, + {}, + { + "description": "bus address of the GPU device or MDEV UUID for vGPU devices", + "name": "busaddress", "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 +114623,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, @@ -114112,38 +114634,28 @@ ], "related": "", "response": [ - { - "description": "the project name of the group", - "name": "project", - "type": "string" - }, {}, { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the ID of the security group", - "name": "id", + "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 egress rules associated with the security group", + "name": "egressrule", "response": [ { - "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": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -114152,57 +114664,62 @@ "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": "tag key name", + "name": "key", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "id of the resource", + "name": "resourceid", "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 project id the tag belongs to", + "name": "projectid", "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 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" } ], "type": "set" }, { - "description": "account owning the security group rule", - "name": "account", - "type": "string" + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the 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", @@ -114210,13 +114727,13 @@ "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 ending IP of the security group rule ", - "name": "endport", + "description": "the starting IP of the security group rule", + "name": "startport", "type": "integer" }, { @@ -114225,40 +114742,41 @@ "type": "string" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "account owning the security group rule", + "name": "account", "type": "string" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", + "description": "the code for the ICMP message response", + "name": "icmpcode", "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", + "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" }, { @@ -114272,8 +114790,8 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -114281,100 +114799,70 @@ "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", + "description": "tag key name", + "name": "key", "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" } ], "type": "set" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" - }, - { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the account owning the security group", - "name": "account", - "type": "string" - }, { "description": "the project id of the group", "name": "projectid", "type": "string" }, { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", "response": [ + { + "description": "security group name", + "name": "securitygroupname", + "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 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", - "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": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -114383,13 +114871,13 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -114397,47 +114885,37 @@ "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", + "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 domain associated with the tag", - "name": "domain", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" } ], "type": "set" }, { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the 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", + "description": "the ending IP of the security group rule ", + "name": "endport", "type": "integer" }, { @@ -114446,20 +114924,10 @@ "type": "integer" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "account owning the security group rule", + "name": "account", "type": "string" }, - { - "description": "the 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", @@ -114468,84 +114936,34 @@ ], "type": "set" }, - {} - ], - "since": "4.14.0.0" - }, - { - "description": "Creates a GPU device manually on a host", - "isasync": false, - "name": "createGpuDevice", - "params": [ - { - "description": "Type of GPU device (PCI, MDEV, VGPUOnly). Defaults to PCI.", - "length": 255, - "name": "type", - "required": false, - "type": "string" - }, { - "description": "ID of the host where the GPU device is located", - "length": 255, - "name": "hostid", - "related": "declareHostAsDegraded,reconnectHost", - "required": true, - "type": "uuid" + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" }, { - "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": "the domain name of the security group", + "name": "domain", "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": "ID of the vGPU profile", - "length": 255, - "name": "vgpuprofileid", - "related": "", - "required": true, - "type": "uuid" - }, - { - "description": "ID of the GPU card type", - "length": 255, - "name": "gpucardid", - "related": "", - "required": true, - "type": "uuid" - }, - { - "description": "PCI bus address of the GPU device (e.g., 0000:01:00.0) or UUID for MDEV devices.", - "length": 255, - "name": "busaddress", - "required": true, + "description": "the description of the security group", + "name": "description", "type": "string" - } - ], - "related": "listGpuDevices,discoverGpuDevices", - "response": [ + }, { - "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 ID of the parent GPU device, if this is a vGPU", - "name": "parentgpudeviceid", - "type": "string" + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" }, { - "description": "the vGPU profile name assigned to this GPU device", - "name": "vgpuprofilename", + "description": "path of the Domain the security group belongs to", + "name": "domainpath", "type": "string" }, { @@ -114553,86 +114971,41 @@ "name": "jobstatus", "type": "integer" }, - {}, - {}, - { - "description": "the vGPU profile ID assigned to this GPU device", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the ID of the GPU device", - "name": "id", - "type": "string" - }, - { - "description": "the host name where the GPU device is attached", - "name": "hostname", - "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", - "type": "string" - }, - { - "description": "the managed state of the GPU device (Enabled/Disabled)", - "name": "managedstate", - "type": "managedstate" - }, - { - "description": "the vGPU profile name assigned to this GPU device", - "name": "state", - "type": "state" - }, - { - "description": "the vGPU profile ID assigned to this GPU device", - "name": "vgpuprofileid", - "type": "string" - }, { - "description": "the NUMA node where the GPU device is located", - "name": "numanode", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the account owning the security group", + "name": "account", "type": "string" }, { - "description": "the GPU card name associated with this GPU device", - "name": "gpucardname", + "description": "the project name of the group", + "name": "project", "type": "string" }, { - "description": "bus address of the GPU device or MDEV UUID for vGPU devices", - "name": "busaddress", + "description": "the ID of the security group", + "name": "id", "type": "string" }, { - "description": "the GPU card ID associated with this GPU device", - "name": "gpucardid", + "description": "the domain ID of the security group", + "name": "domainid", "type": "string" - }, - { - "description": "the state of the virtual machine to which this GPU device is allocated", - "name": "vmstate", - "type": "state" } ], - "since": "4.21.0" + "since": "4.14.0.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 +115014,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,50 +115027,43 @@ "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", - "type": "long" + "description": "the total memory (in MB) available to be created for this domain", + "name": "memoryavailable", + "type": "string" }, { - "description": "the total number of templates which can be created by this domain", - "name": "templatelimit", + "description": "the total number of projects the domain can own", + "name": "projectlimit", "type": "string" }, { - "description": "the total number of vpcs available to be created for this domain", - "name": "vpcavailable", + "description": "the total primary storage space (in GiB) the domain can own", + "name": "primarystoragelimit", "type": "string" }, { - "description": "the total number of snapshots available for this domain", - "name": "snapshotavailable", + "description": "the name of the domain", + "name": "name", "type": "string" }, { - "description": "the total number of backups which can be stored by this domain", - "name": "backuplimit", + "description": "the state of the domain", + "name": "state", "type": "string" }, { - "description": "the total number of snapshots stored by this domain", - "name": "snapshottotal", + "description": "the total volume being used by this domain", + "name": "volumetotal", "type": "long" }, { - "description": "the total volume which can be used by this domain", - "name": "volumelimit", + "description": "the total number of vpcs available to be created for this domain", + "name": "vpcavailable", "type": "string" }, { @@ -114706,38 +115072,33 @@ "type": "long" }, { - "description": "the total number of backups stored by this domain", - "name": "backuptotal", + "description": "the total number of virtual machines deployed by this domain", + "name": "vmtotal", "type": "long" }, { - "description": "the state of the domain", - "name": "state", - "type": "string" - }, - { - "description": "the total object storage space (in GiB) owned by the domain", - "name": "objectstoragetotal", + "description": "the total number of projects being administrated by this domain", + "name": "projecttotal", "type": "long" }, { - "description": "the total number of public ip addresses allocated for this domain", - "name": "iptotal", - "type": "long" + "description": "the total number of cpu cores the domain can own", + "name": "cpulimit", + "type": "string" }, { - "description": "the total volume being used by this domain", - "name": "volumetotal", - "type": "long" + "description": "the total object storage space (in GiB) the domain can own", + "name": "objectstoragelimit", + "type": "string" }, { - "description": "the total memory (in MB) available to be created for this domain", - "name": "memoryavailable", - "type": "string" + "description": "the total object storage space (in GiB) owned by the domain", + "name": "objectstoragetotal", + "type": "long" }, { - "description": "the total number of snapshots which can be stored by this domain", - "name": "snapshotlimit", + "description": "the total number of gpus available to be created for this domain", + "name": "gpuavailable", "type": "string" }, { @@ -114746,44 +115107,48 @@ "type": "long" }, { - "description": "the name of the domain", - "name": "name", + "description": "the ID of the domain", + "name": "id", "type": "string" }, { - "description": "the path of the domain", - "name": "path", + "description": "the total number of backups available to this domain", + "name": "backupavailable", "type": "string" }, { - "description": "the total backup storage space (in GiB) the domain can own", - "name": "backupstoragelimit", + "description": "the total number of snapshots available for this domain", + "name": "snapshotavailable", "type": "string" }, { - "description": "the total number of networks owned by domain", - "name": "networktotal", - "type": "long" + "description": "the total volume available for this domain", + "name": "volumeavailable", + "type": "string" }, { - "description": "the total memory (in MB) owned by domain", - "name": "memorytotal", + "description": "the total number of backups stored by this domain", + "name": "backuptotal", "type": "long" }, { - "description": "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 level of the domain", - "name": "level", - "type": "integer" + "description": "the domain name of the parent domain", + "name": "parentdomainname", + "type": "string" }, - {}, { - "description": "the total number of cpu cores the domain can own", - "name": "cpulimit", + "description": "the total number of buckets available to this domain", + "name": "bucketavailable", + "type": "string" + }, + { + "description": "the total number of vpcs the domain can own", + "name": "vpclimit", "type": "string" }, { @@ -114792,38 +115157,39 @@ "type": "string" }, { - "description": "the total secondary storage space (in GiB) the domain can own", - "name": "secondarystoragelimit", + "description": "the total object storage space (in GiB) available to the domain", + "name": "objectstorageavailable", "type": "string" }, { - "description": "the date when this domain was created", - "name": "created", - "type": "date" + "description": "the total number of projects available for administration by this domain", + "name": "projectavailable", + "type": "string" }, { - "description": "the total volume available for this domain", - "name": "volumeavailable", + "description": "the total secondary storage space (in GiB) the domain can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "the total number of projects the domain can own", - "name": "projectlimit", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total number of buckets which can be stored by this domain", + "name": "bucketlimit", "type": "string" }, { - "description": "the total number of projects being administrated by this domain", - "name": "projecttotal", - "type": "long" + "description": "the total primary storage space (in GiB) available to be used for this domain", + "name": "primarystorageavailable", + "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" }, { @@ -114832,13 +115198,18 @@ "type": "string" }, { - "description": "the total number of buckets which can be stored by this domain", - "name": "bucketlimit", + "description": "the total backup storage space (in GiB) the domain can own", + "name": "backupstoragelimit", "type": "string" }, { - "description": "the total number of projects available for administration by this domain", - "name": "projectavailable", + "description": "the 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 domain", + "name": "backupstorageavailable", "type": "string" }, { @@ -114847,58 +115218,63 @@ "type": "string" }, { - "description": "the total primary storage space (in GiB) available to be used for this domain", - "name": "primarystorageavailable", + "description": "the total number of networks the domain can own", + "name": "networklimit", "type": "string" }, { - "description": "the total backup storage space (in GiB) available to the domain", - "name": "backupstorageavailable", - "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 parent domain", - "name": "parentdomainname", + "description": "the total volume which can be used by this domain", + "name": "volumelimit", "type": "string" }, { - "description": "the total number of templates which have been created by this domain", - "name": "templatetotal", + "description": "the total secondary storage space (in GiB) owned by domain", + "name": "secondarystoragetotal", + "type": "float" + }, + { + "description": "the total number of public ip addresses allocated for this domain", + "name": "iptotal", "type": "long" }, { - "description": "the total number of virtual machines available for this domain to acquire", - "name": "vmavailable", - "type": "string" + "description": "the total memory (in MB) owned by domain", + "name": "memorytotal", + "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 gpus owned by domain", + "name": "gputotal", + "type": "long" }, { - "description": "the total number of gpus the domain can own", - "name": "gpulimit", + "description": "the path of the domain", + "name": "path", "type": "string" }, { - "description": "the total number of backups available to this domain", - "name": "backupavailable", - "type": "string" + "description": "the total number of vpcs owned by domain", + "name": "vpctotal", + "type": "long" }, { - "description": "the total number of buckets available to this domain", - "name": "bucketavailable", + "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 templates available to be created by this domain", + "name": "templateavailable", "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" }, { @@ -114907,100 +115283,90 @@ "type": "string" }, { - "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 secondary storage space (in GiB) owned by domain", - "name": "secondarystoragetotal", - "type": "float" - }, - {}, - { - "description": "the total number of templates available to be created by this domain", - "name": "templateavailable", - "type": "string" - }, - { - "description": "the total number of buckets stored by this domain", - "name": "buckettotal", - "type": "long" - }, - { - "description": "the total number of vpcs the domain can own", - "name": "vpclimit", + "description": "the total number of public ip addresses this domain can acquire", + "name": "iplimit", "type": "string" }, { - "description": "whether the domain has one or more sub-domains", - "name": "haschild", + "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", + "description": "the total number of snapshots which can be stored by this domain", + "name": "snapshotlimit", "type": "string" }, { - "description": "the total object storage space (in GiB) available to the domain", - "name": "objectstorageavailable", + "description": "the total secondary storage space (in GiB) available to be used for this domain", + "name": "secondarystorageavailable", "type": "string" }, + { + "description": "the total primary storage space (in GiB) owned by domain", + "name": "primarystoragetotal", + "type": "long" + }, + {}, { "description": "the total number of public ip addresses available for this domain to acquire", "name": "ipavailable", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The tagged resource limit and count for the domain", + "name": "taggedresources", + "type": "list" }, { - "description": "the total number of gpus owned by domain", - "name": "gputotal", - "type": "long" + "description": "details for the domain", + "name": "domaindetails", + "type": "map" }, { - "description": "the total object storage space (in GiB) the domain can own", - "name": "objectstoragelimit", - "type": "string" + "description": "the level of the domain", + "name": "level", + "type": "integer" }, { - "description": "The tagged resource limit and count for the domain", - "name": "taggedresources", - "type": "list" + "description": "the date when this domain was created", + "name": "created", + "type": "date" }, { - "description": "the ID of the domain", - "name": "id", + "description": "the total number of backups which can be stored by this domain", + "name": "backuplimit", "type": "string" }, { - "description": "the total number of networks the domain can own", - "name": "networklimit", + "description": "the total number of gpus the domain can own", + "name": "gpulimit", "type": "string" }, { - "description": "the total number of vpcs owned by domain", - "name": "vpctotal", + "description": "the total number of templates which have been created by this domain", + "name": "templatetotal", "type": "long" }, { - "description": "the total number of public ip addresses this domain can acquire", - "name": "iplimit", + "description": "the total number of templates which can be created by this domain", + "name": "templatelimit", "type": "string" }, { - "description": "the total number of virtual machines that can be deployed by this domain", - "name": "vmlimit", + "description": "the total number of networks owned by domain", + "name": "networktotal", + "type": "long" + }, + { + "description": "the network domain", + "name": "networkdomain", "type": "string" + }, + { + "description": "the total number of buckets stored by this domain", + "name": "buckettotal", + "type": "long" } ] }, @@ -115009,21 +115375,6 @@ "isasync": false, "name": "addImageStore", "params": [ - { - "description": "the Zone ID for the image store", - "length": 255, - "name": "zoneid", - "related": "listZones", - "required": false, - "type": "uuid" - }, - { - "description": "the name for the image store", - "length": 255, - "name": "name", - "required": false, - "type": "string" - }, { "description": "the image store provider name", "length": 255, @@ -115038,42 +115389,62 @@ "required": false, "type": "string" }, + { + "description": "the Zone ID for the image store", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" + }, { "description": "the details for the image store. Example: details[0].key=accesskey&details[0].value=s389ddssaa&details[1].key=secretkey&details[1].value=8dshfsss", "length": 255, "name": "details", "required": false, "type": "map" + }, + { + "description": "the name for the image store", + "length": 255, + "name": "name", + "required": false, + "type": "string" } ], "related": "addSecondaryStorage,listSwifts", "response": [ + {}, { - "description": "the protocol of the image store", - "name": "protocol", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the provider name of the image store", - "name": "providername", + "description": "the name of the image store", + "name": "name", "type": "string" }, + {}, { - "description": "the host's currently used disk size", - "name": "disksizeused", + "description": "the total disk size of the host", + "name": "disksizetotal", "type": "long" }, - {}, { - "description": "the name of the image store", - "name": "name", + "description": "the scope of the image store", + "name": "scope", + "type": "scopetype" + }, + { + "description": "the Zone name of the image store", + "name": "zonename", "type": "string" }, - {}, { - "description": "defines if store is read-only", - "name": "readonly", - "type": "boolean" + "description": "the protocol of the image store", + "name": "protocol", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", @@ -115081,44 +115452,39 @@ "type": "integer" }, { - "description": "the url of the image store", - "name": "url", - "type": "string" + "description": "defines if store is read-only", + "name": "readonly", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the scope of the image store", - "name": "scope", - "type": "scopetype" + "description": "the provider name of the image store", + "name": "providername", + "type": "string" }, { - "description": "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 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": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the url of the image store", + "name": "url", + "type": "string" } ], "since": "4.2.0" @@ -115129,16 +115495,17 @@ "name": "revokeTemplateDirectDownloadCertificate", "params": [ { - "description": "(optional) alias of the SSL certificate", + "description": "(optional) the host ID to revoke certificate", "length": 255, - "name": "name", + "name": "hostid", + "related": "declareHostAsDegraded,reconnectHost", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "(optional) hypervisor type", + "description": "(optional) alias of the SSL certificate", "length": 255, - "name": "hypervisor", + "name": "name", "required": false, "type": "string" }, @@ -115150,14 +115517,6 @@ "required": false, "type": "uuid" }, - { - "description": "(optional) the host ID to revoke certificate", - "length": 255, - "name": "hostid", - "related": "declareHostAsDegraded,reconnectHost", - "required": false, - "type": "uuid" - }, { "description": "(optional) zone to revoke certificate", "length": 255, @@ -115165,40 +115524,47 @@ "related": "listZones", "required": true, "type": "uuid" + }, + { + "description": "(optional) hypervisor type", + "length": 255, + "name": "hypervisor", + "required": false, + "type": "string" } ], "related": "provisionTemplateDirectDownloadCertificate", "response": [ + {}, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the host", + "name": "hostid", "type": "string" }, { - "description": "indicates the details in case of failure or host skipped", - "name": "details", + "description": "the name of the host", + "name": "hostname", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the name of the host", - "name": "hostname", + "description": "indicates the details in case of failure or host skipped", + "name": "details", "type": "string" }, - {}, { - "description": "the ID of the host", - "name": "hostid", + "description": "indicates if the certificate has been revoked from the host, failed or skipped", + "name": "status", "type": "string" }, { - "description": "indicates if the certificate has been revoked from the host, failed or skipped", - "name": "status", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ], @@ -115221,24 +115587,25 @@ "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", "response": [ { - "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": "the storage access groups for the storage pool", - "name": "storageaccessgroups", + "description": "the tags for the storage pool", + "name": "tags", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the nfs mount options for the storage pool", - "name": "nfsmountopts", - "type": "string" + "description": "the pool's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" }, { "description": "the total disk size of the storage pool", @@ -115246,25 +115613,13 @@ "type": "long" }, { - "description": "the hypervisor type of the storage pool", - "name": "hypervisor", - "type": "string" - }, - {}, - { - "description": "total IOPS currently in use", - "name": "usediops", - "type": "long" - }, - { - "description": "total min IOPS currently in use by volumes", - "name": "allocatediops", + "description": "IOPS CloudStack can provision from this storage pool", + "name": "capacityiops", "type": "long" }, - {}, { - "description": "the name of the cluster for the storage pool", - "name": "clustername", + "description": "the storage access groups for the storage pool", + "name": "storageaccessgroups", "type": "string" }, { @@ -115273,14 +115628,19 @@ "type": "boolean" }, { - "description": "the ID of the storage pool", - "name": "id", + "description": "Storage provider for this pool", + "name": "provider", "type": "string" }, { - "description": "the storage pool capabilities", - "name": "storagecapabilities", - "type": "map" + "description": "whether this pool is managed or not", + "name": "managed", + "type": "boolean" + }, + { + "description": "the IP address of the storage pool", + "name": "ipaddress", + "type": "string" }, { "description": "the ID of the cluster for the storage pool", @@ -115288,19 +115648,19 @@ "type": "string" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "the Zone name of the storage pool", + "name": "zonename", + "type": "string" }, { - "description": "Storage provider for this pool", - "name": "provider", - "type": "string" + "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 storage pool type", + "name": "type", + "type": "string" }, { "description": "the overprovisionfactor for the storage pool", @@ -115308,9 +115668,9 @@ "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the scope of the storage pool", + "name": "scope", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", @@ -115318,19 +115678,25 @@ "type": "integer" }, { - "description": "the Zone name of the storage pool", - "name": "zonename", - "type": "string" + "description": "the date and time the storage pool was created", + "name": "created", + "type": "date" }, + {}, { - "description": "the storage pool path", - "name": "path", + "description": "the name of the storage pool", + "name": "name", "type": "string" }, { - "description": "the storage pool type", - "name": "type", - "type": "string" + "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 storage pool custom stats", @@ -115338,33 +115704,33 @@ "type": "map" }, { - "description": "the date and time the storage pool was created", - "name": "created", - "type": "date" + "description": "the ID of the storage pool", + "name": "id", + "type": "string" }, { - "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 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 storage pool path", + "name": "path", + "type": "string" }, { - "description": "the Pod name of the storage pool", - "name": "podname", + "description": "the name of the cluster for the storage pool", + "name": "clustername", "type": "string" }, { - "description": "the tags for the storage pool", - "name": "tags", + "description": "the hypervisor type of the storage pool", + "name": "hypervisor", "type": "string" }, { @@ -115373,29 +115739,34 @@ "type": "string" }, { - "description": "the name of the storage pool", - "name": "name", - "type": "string" + "description": "total IOPS currently in use", + "name": "usediops", + "type": "long" }, { - "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 scope of the storage pool", - "name": "scope", + "description": "the pool's currently used disk size", + "name": "disksizeused", + "type": "long" + }, + { + "description": "the Zone ID of the storage pool", + "name": "zoneid", "type": "string" }, { - "description": "IOPS CloudStack can provision from this storage pool", - "name": "capacityiops", - "type": "long" + "description": "the Pod name of the storage pool", + "name": "podname", + "type": "string" }, { - "description": "whether this pool is managed or not", - "name": "managed", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ], "since": "4.16.0" @@ -115406,11 +115777,12 @@ "name": "unregisterExtension", "params": [ { - "description": "Type of the resource", + "description": "ID of the extension", "length": 255, - "name": "resourcetype", + "name": "extensionid", + "related": "listExtensions,updateExtension,unregisterExtension", "required": true, - "type": "string" + "type": "uuid" }, { "description": "ID of the resource to register the extension with", @@ -115420,30 +115792,24 @@ "type": "string" }, { - "description": "ID of the extension", + "description": "Type of the resource", "length": 255, - "name": "extensionid", - "related": "listExtensions,updateExtension,unregisterExtension", + "name": "resourcetype", "required": true, - "type": "uuid" + "type": "string" } ], "related": "listExtensions,updateExtension", "response": [ {}, { - "description": "The path of the entry point fo the extension", - "name": "path", - "type": "string" - }, - { - "description": "ID of the extension", - "name": "id", - "type": "string" + "description": "True if the extension is added by admin", + "name": "isuserdefined", + "type": "boolean" }, { - "description": "Removal timestamp of the extension, if applicable", - "name": "removed", + "description": "Creation timestamp of the extension", + "name": "created", "type": "date" }, { @@ -115451,58 +115817,48 @@ "name": "resources", "response": [ { - "description": "ID of the resource associated with the extension", - "name": "id", + "description": "Type of the resource", + "name": "type", "type": "string" }, - { - "description": "the details of the resource map", - "name": "details", - "type": "map" - }, { "description": "Name of the resource associated with this mapping", "name": "name", "type": "string" }, { - "description": "Type of the resource", - "name": "type", + "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": "Creation timestamp of the extension", - "name": "created", - "type": "date" - }, - { - "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": "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": "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 state of the extension", + "name": "state", + "type": "string" }, { "description": "Name of the extension", @@ -115510,25 +115866,40 @@ "type": "string" }, { - "description": "Type of the extension", - "name": "type", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "The state of the extension", - "name": "state", + "description": "Description of the extension", + "name": "description", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "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": "Type of the extension", + "name": "type", "type": "string" }, { - "description": "Description of the extension", - "name": "description", + "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" + }, {} ], "since": "4.21.0" @@ -115546,38 +115917,33 @@ "type": "string" }, { - "description": "", + "description": "NSX controller added to the specific zone", "length": 255, - "name": "pagesize", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "integer" + "type": "uuid" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "NSX controller added to the specific zone", + "description": "", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" } ], "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", + "description": "Zone name to which the NSX controller is associated with", + "name": "zonename", "type": "string" }, { @@ -115586,25 +115952,20 @@ "type": "string" }, { - "description": "Zone name to which the NSX controller is associated with", - "name": "zonename", + "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 UUID of the latest async job acting on this object", - "name": "jobid", - "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" }, { @@ -115613,9 +115974,9 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The tier-0 gateway network. Tier-0 gateway is responsible for handling traffic between logical and physical networks", + "name": "tier0gateway", + "type": "string" }, { "description": "The name of the edge cluster. An edge cluster is a logical grouping of edge nodes in NSX", @@ -115623,8 +115984,18 @@ "type": "string" }, { - "description": "NSX controller ID", - "name": "nsxprovideruuid", + "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" + }, + { + "description": "NSX controller port", + "name": "port", "type": "string" } ], @@ -115643,14 +116014,6 @@ "required": false, "type": "uuid" }, - { - "description": "The ID of the volume to be reassigned.", - "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 project to which the volume will be assigned. Mutually exclusive with 'accountid'.", "length": 255, @@ -115658,128 +116021,178 @@ "related": "", "required": false, "type": "uuid" + }, + { + "description": "The ID of the volume to be reassigned.", + "length": 255, + "name": "volumeid", + "related": "importVolume,createVolume,updateVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", + "required": true, + "type": "uuid" } ], - "related": "createVolume,updateVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,importVolume", + "related": "importVolume,createVolume,updateVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "response": [ { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "max iops of the disk volume", - "name": "maxiops", + "description": "size of the disk volume", + "name": "size", "type": "long" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", - "type": "boolean" + "description": "name of the primary storage hosting the disk volume", + "name": "storage", + "type": "string" }, { - "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 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": "size of the disk volume", - "name": "size", - "type": "long" + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", + "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "type": "string" }, { - "description": "state of the virtual machine", - "name": "vmstate", - "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": "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": "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 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": "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": "ID of the disk volume", - "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": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "the format of the disk encryption if applicable", + "name": "encryptformat", "type": "string" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "description": "state of the virtual machine", + "name": "vmstate", "type": "string" }, { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "pod id of the volume", - "name": "podid", + "description": "name of the virtual machine", + "name": "vmname", "type": "string" }, { - "description": "true if volume has delete protection.", - "name": "deleteprotection", - "type": "boolean" - }, - { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "the path of the volume", + "name": "path", "type": "string" }, { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", - "type": "long" - }, - { - "description": "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": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "the state of the disk volume", + "name": "state", "type": "string" }, { - "description": "the state of the disk volume", - "name": "state", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "description": "type of the virtual machine", + "name": "vmtype", "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" }, { @@ -115788,84 +116201,104 @@ "type": "string" }, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", - "type": "string" + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "type": "long" }, { - "description": "type of the virtual machine", - "name": "vmtype", + "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": "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": "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 template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "name of the virtual machine", - "name": "vmname", - "type": "string" + "description": "min iops of the disk volume", + "name": "miniops", + "type": "long" }, { - "description": "the status of the volume", - "name": "status", + "description": "shared or local storage", + "name": "storagetype", "type": "string" }, { - "description": "cluster id of the volume", - "name": "clusterid", - "type": "string" + "description": "the bytes allocated", + "name": "virtualsize", + "type": "long" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "the chain info of the volume", + "name": "chaininfo", "type": "string" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", + "type": "boolean" + }, + { + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", + "type": "boolean" + }, + { + "description": "the date the disk volume was created", + "name": "created", "type": "date" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", - "type": "string" + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", + "type": "boolean" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "shared or local storage", - "name": "storagetype", + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, { - "description": "the bytes allocated", - "name": "virtualsize", - "type": "long" + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", - "type": "boolean" + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" + }, + { + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", + "type": "string" }, { "description": "true if the volume is extractable, false otherwise", @@ -115873,135 +116306,79 @@ "type": "boolean" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", - "name": "deviceid", + "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", + "description": "ID of the disk volume", + "name": "id", "type": "string" }, { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", - "type": "boolean" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", + "description": "path of the Domain the disk volume belongs to", + "name": "domainpath", "type": "string" }, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", - "type": "string" + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", + "type": "long" }, { - "description": "details for the volume repair result, they may vary for different hypervisors", - "name": "volumerepairresult", - "type": "map" + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" }, { - "description": "the project id of the vpn", - "name": "projectid", + "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", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", + "type": "string" }, { - "description": "the format of the disk encryption if applicable", - "name": "encryptformat", + "description": "cluster id of the volume", + "name": "clusterid", "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 check result, they may vary for different hypervisors", - "name": "volumecheckresult", - "type": "map" + "description": "pod id of the volume", + "name": "podid", + "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": "name of the service offering for root disk", - "name": "serviceofferingname", + "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": "the ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, { @@ -116010,82 +116387,76 @@ "type": "long" }, { - "description": "name of the disk volume", - "name": "name", + "description": "id of the virtual machine", + "name": "virtualmachineid", "type": "string" }, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", "type": "string" }, { - "description": "min iops of the disk volume", - "name": "miniops", - "type": "long" + "description": "cluster name where the volume is allocated", + "name": "clustername", + "type": "string" }, + {}, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", + "type": "long" }, { - "description": "the disk utilization", - "name": "utilization", + "description": "the project id of the vpn", + "name": "projectid", "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": "id of the virtual machine", - "name": "virtualmachineid", + "description": "the disk utilization", + "name": "utilization", "type": "string" }, - {}, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "display name of the virtual machine", + "name": "vmdisplayname", "type": "string" }, { - "description": "name of the availability zone", - "name": "zonename", - "type": "string" + "description": "true if volume has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "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 project name of the vpn", + "name": "project", "type": "string" }, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" - }, - {} + "description": "name of the disk offering", + "name": "diskofferingname", + "type": "string" + } ], "since": "4.18.0.0" }, @@ -116095,19 +116466,19 @@ "name": "deleteUserData", "params": [ { - "description": "an optional account for the userdata. Must be used with domainId.", + "description": "an optional project for the userdata", "length": 255, - "name": "account", + "name": "projectid", + "related": "", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the ID of the Userdata", + "description": "an optional account for the userdata. Must be used with domainId.", "length": 255, - "name": "id", - "related": "", - "required": true, - "type": "uuid" + "name": "account", + "required": false, + "type": "string" }, { "description": "an optional domainId for the userdata. If the account parameter is used, domainId must also be used.", @@ -116118,19 +116489,19 @@ "type": "uuid" }, { - "description": "an optional project for the userdata", + "description": "the ID of the Userdata", "length": 255, - "name": "projectid", + "name": "id", "related": "", - "required": false, + "required": true, "type": "uuid" } ], "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" }, {}, { @@ -116138,12 +116509,12 @@ "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", @@ -116158,9 +116529,9 @@ "name": "listSupportedNetworkServices", "params": [ { - "description": "network service name to list providers and capabilities of", + "description": "List by keyword", "length": 255, - "name": "service", + "name": "keyword", "required": false, "type": "string" }, @@ -116171,13 +116542,6 @@ "required": false, "type": "string" }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, { "description": "", "length": 255, @@ -116191,28 +116555,29 @@ "name": "pagesize", "required": false, "type": "integer" + }, + { + "description": "network service name to list providers and capabilities of", + "length": 255, + "name": "service", + "required": false, + "type": "string" } ], "related": "", "response": [ - { - "description": "the service name", - "name": "name", - "type": "string" - }, - {}, { "description": "the list of capabilities", "name": "capability", "response": [ { - "description": "the capability value", - "name": "value", + "description": "the capability name", + "name": "name", "type": "string" }, { - "description": "the capability name", - "name": "name", + "description": "the capability value", + "name": "value", "type": "string" }, { @@ -116223,12 +116588,6 @@ ], "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", @@ -116238,21 +116597,6 @@ "description": "the service provider name", "name": "provider", "response": [ - { - "description": "state of the network provider", - "name": "state", - "type": "string" - }, - { - "description": "uuid of the network provider", - "name": "id", - "type": "string" - }, - { - "description": "the provider name", - "name": "name", - "type": "string" - }, { "description": "services for this provider", "name": "servicelist", @@ -116263,6 +116607,11 @@ "name": "canenableindividualservice", "type": "boolean" }, + { + "description": "state of the network provider", + "name": "state", + "type": "string" + }, { "description": "the physical network this belongs to", "name": "physicalnetworkid", @@ -116272,10 +116621,32 @@ "description": "the destination physical network", "name": "destinationphysicalnetworkid", "type": "string" + }, + { + "description": "the provider name", + "name": "name", + "type": "string" + }, + { + "description": "uuid of the network provider", + "name": "id", + "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" + }, + {} ], "since": "3.0.0" }, @@ -116299,23 +116670,23 @@ "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" - } + {}, + {} ] }, { @@ -116323,21 +116694,6 @@ "isasync": true, "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", - "length": 255, - "name": "physicalnetworkid", - "related": "", - "required": true, - "type": "uuid" - }, { "description": "the list of services to be enabled for this physical network service provider", "length": 255, @@ -116352,17 +116708,41 @@ "related": "", "required": false, "type": "uuid" + }, + { + "description": "the Physical Network ID to add the provider to", + "length": 255, + "name": "physicalnetworkid", + "related": "", + "required": true, + "type": "uuid" + }, + { + "description": "the name for the physical network service provider", + "length": 255, + "name": "name", + "required": true, + "type": "string" } ], - "related": "listTrafficTypes", + "related": "", "response": [ - {}, - {}, { "description": "the physical network this belongs to", "name": "physicalnetworkid", "type": "string" }, + { + "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", @@ -116374,10 +116754,11 @@ "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" }, + {}, { "description": "the provider name", "name": "name", @@ -116389,18 +116770,8 @@ "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": "state of the network provider", - "name": "state", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ], @@ -116423,25 +116794,25 @@ "response": [ {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, - {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, + {}, + { + "description": "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" } ] }, @@ -116460,27 +116831,27 @@ } ], "response": [ + {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ], "since": "4.18.0.0" @@ -116491,116 +116862,107 @@ "name": "createServiceOffering", "params": [ { - "description": "the ID of the vGPU profile to which service offering should be mapped", + "description": "Lease expiry action, valid values are STOP and DESTROY", "length": 255, - "name": "vgpuprofileid", - "related": "", + "name": "leaseexpiryaction", "required": false, - "since": "4.21", - "type": "uuid" + "since": "4.21.0", + "type": "string" }, { - "description": "For VMware and Xen based hypervisors this is the CPU speed of the service offering in MHz.\nFor the KVM hypervisor, the values of the parameters cpuSpeed and cpuNumber will be used to calculate the `shares` value. This value is used by the KVM hypervisor to calculate how much time the VM will have access to the host's CPU. The `shares` value does not have a unit, and its purpose is being a weight value for the host to compare between its guest VMs. For more information, see https://libvirt.org/formatdomain.html#cpu-tuning.", + "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", "length": 255, - "name": "cpuspeed", + "name": "provisioningtype", "required": false, - "type": "integer" + "type": "string" }, { - "description": "the host tag for this service offering.", + "description": "length (in seconds) of the burst", "length": 255, - "name": "hosttags", + "name": "bytesreadratemaxlength", "required": false, - "type": "string" + "type": "long" }, { - "description": "the storage type of the service offering. Values are local and shared.", + "description": "The minimum memory size of the custom service offering in MB", "length": 255, - "name": "storagetype", + "name": "minmemory", "required": false, - "type": "string" + "since": "4.13", + "type": "integer" }, { - "description": "is this a system vm offering", + "description": "the HA for the service offering", "length": 255, - "name": "issystem", + "name": "offerha", "required": false, "type": "boolean" }, { - "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": "Whether to cleanup instance and its associated resource from database upon expunge of the instance", "length": 255, - "name": "deploymentplanner", + "name": "purgeresources", "required": false, - "type": "string" + "since": "4.20", + "type": "boolean" }, { - "description": "whether compute offering iops is custom or not", + "description": "Whether service offering size is custom or not", "length": 255, - "name": "customizediops", + "name": "customized", "required": false, - "since": "4.4", + "since": "4.13", "type": "boolean" }, { - "description": "bytes write rate of the disk offering", + "description": "The maximum number of CPUs to be set with Custom Computer Offering", "length": 255, - "name": "byteswriterate", + "name": "maxcpunumber", "required": false, - "type": "long" + "since": "4.13", + "type": "integer" }, { - "description": "Name of the storage policy defined at vCenter, this is applicable only for VMware", + "description": "length (in seconds) of the burst", "length": 255, - "name": "storagepolicy", - "related": "", + "name": "iopsreadratemaxlength", "required": false, - "since": "4.15", - "type": "uuid" + "type": "long" }, { - "description": "the tags for this service offering.", + "description": "the storage type of the service offering. Values are local and shared.", "length": 255, - "name": "tags", + "name": "storagetype", "required": false, "type": "string" }, { - "description": "io requests read rate of the disk offering", - "length": 255, - "name": "iopsreadrate", - "required": false, - "type": "long" - }, - { - "description": "burst io requests write rate of the disk offering", + "description": "burst requests read rate of the disk offering", "length": 255, - "name": "iopswriteratemax", + "name": "iopsreadratemax", "required": false, "type": "long" }, { - "description": "the ID of the containing zone(s), null for public offerings", + "description": "Details in key/value pairs using format externaldetails[i].keyname=keyvalue. Example: externaldetails[0].endpoint.url=urlvalue", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "externaldetails", "required": false, - "since": "4.13", - "type": "list" + "since": "4.21.0", + "type": "map" }, { - "description": "length (in seconds) of the burst", + "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": "iopswriteratemaxlength", + "name": "cpuspeed", "required": false, - "type": "long" + "type": "integer" }, { - "description": "the cache mode to use for this disk offering. none, writeback or writethrough", + "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": "cachemode", + "name": "deploymentplanner", "required": false, - "since": "4.14", "type": "string" }, { @@ -116612,69 +116974,62 @@ "type": "integer" }, { - "description": "length (in seconds) of the burst", - "length": 255, - "name": "bytesreadratemaxlength", - "required": false, - "type": "long" - }, - { - "description": "the system VM type. Possible types are \"domainrouter\", \"consoleproxy\" and \"secondarystoragevm\".", + "description": "the host tag for this service offering.", "length": 255, - "name": "systemvmtype", + "name": "hosttags", "required": false, "type": "string" }, { - "description": "VMs using this offering require root volume encryption", + "description": "io requests write rate of the disk offering", "length": 255, - "name": "encryptroot", + "name": "iopswriterate", "required": false, - "since": "4.18", - "type": "boolean" + "type": "long" }, { - "description": "Whether service offering size is custom or not", + "description": "bytes read rate of the disk offering", "length": 255, - "name": "customized", + "name": "bytesreadrate", "required": false, - "since": "4.13", - "type": "boolean" + "type": "long" }, { - "description": "The maximum number of CPUs to be set with Custom Computer Offering", + "description": "Name of the storage policy defined at vCenter, this is applicable only for VMware", "length": 255, - "name": "maxcpunumber", + "name": "storagepolicy", + "related": "", "required": false, - "since": "4.13", - "type": "integer" + "since": "4.15", + "type": "uuid" }, { - "description": "the Root disk size in GB.", + "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": "rootdisksize", + "name": "gpudisplay", "required": false, - "since": "4.15", - "type": "long" + "since": "4.21", + "type": "boolean" }, { - "description": "length (in seconds) of the burst", + "description": "true if the virtual machine needs to be volatile so that on every reboot of VM, original root disk is dettached then destroyed and a fresh root disk is created and attached to VM", "length": 255, - "name": "byteswriteratemaxlength", + "name": "isvolatile", "required": false, - "type": "long" + "type": "boolean" }, { - "description": "restrict the CPU usage to committed service offering", + "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": "limitcpuuse", + "name": "diskofferingstrictness", "required": false, + "since": "4.17", "type": "boolean" }, { - "description": "bytes read rate of the disk offering", + "description": "burst bytes write rate of the disk offering", "length": 255, - "name": "bytesreadrate", + "name": "byteswriteratemax", "required": false, "type": "long" }, @@ -116687,49 +117042,53 @@ "type": "boolean" }, { - "description": "the HA for the service offering", + "description": "The display text of the service offering, defaults to 'name'.", "length": 255, - "name": "offerha", + "name": "displaytext", + "required": false, + "type": "string" + }, + { + "description": "is this a system vm offering", + "length": 255, + "name": "issystem", "required": false, "type": "boolean" }, { - "description": "Number of days instance is leased for.", + "description": "the system VM type. Possible types are \"domainrouter\", \"consoleproxy\" and \"secondarystoragevm\".", "length": 255, - "name": "leaseduration", + "name": "systemvmtype", "required": false, - "since": "4.21.0", - "type": "integer" + "type": "string" }, { - "description": "Count of GPUs to be used with this service offering. This is applicable only when passed with vGPU profile.", + "description": "bytes write rate of the disk offering", "length": 255, - "name": "gpucount", + "name": "byteswriterate", "required": false, - "since": "4.21", - "type": "integer" + "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, "type": "long" }, { - "description": "the ID of the containing domain(s), null for public offerings", + "description": "data transfer rate in megabits per second allowed. Supported only for non-System offering and system offerings having \"domainrouter\" systemvmtype", "length": 255, - "name": "domainid", - "related": "listDomains,listDomains", + "name": "networkrate", "required": false, - "type": "list" + "type": "integer" }, { - "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": "burst bytes read rate of the disk offering", "length": 255, - "name": "isvolatile", + "name": "bytesreadratemax", "required": false, - "type": "boolean" + "type": "long" }, { "description": "max iops of the compute offering", @@ -116740,64 +117099,73 @@ "type": "long" }, { - "description": "The minimum memory size of the custom service offering in MB", + "description": "length (in seconds) of the burst", "length": 255, - "name": "minmemory", + "name": "iopswriteratemaxlength", "required": false, - "since": "4.13", - "type": "integer" + "type": "long" }, { - "description": "the name of the service offering", + "description": "the tags for this service offering.", "length": 255, - "name": "name", - "required": true, + "name": "tags", + "required": false, "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": "the ID of the containing zone(s), null for public offerings", "length": 255, - "name": "diskofferingstrictness", + "name": "zoneid", + "related": "listZones", "required": false, - "since": "4.17", - "type": "boolean" + "since": "4.13", + "type": "list" }, { - "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", + "description": "the Root disk size in GB.", "length": 255, - "name": "provisioningtype", + "name": "rootdisksize", "required": false, - "type": "string" + "since": "4.15", + "type": "long" }, { - "description": "Whether to cleanup instance and its associated resource from database upon expunge of the instance", + "description": "Count of GPUs to be used with this service offering. This is applicable only when passed with vGPU profile.", "length": 255, - "name": "purgeresources", + "name": "gpucount", "required": false, - "since": "4.20", - "type": "boolean" + "since": "4.21", + "type": "integer" }, { - "description": "Whether to enable GPU display for this service offering. This is applicable only when passed with vGPU profile. Defaults to false.", + "description": "the name of the service offering", "length": 255, - "name": "gpudisplay", + "name": "name", + "required": true, + "type": "string" + }, + { + "description": "min iops of the compute offering", + "length": 255, + "name": "miniops", "required": false, - "since": "4.21", - "type": "boolean" + "since": "4.4", + "type": "long" }, { - "description": "the CPU number of the service offering", + "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": "cpunumber", + "name": "cachemode", "required": false, - "type": "integer" + "since": "4.14", + "type": "string" }, { - "description": "io requests write rate of the disk offering", + "description": "restrict the CPU usage to committed service offering", "length": 255, - "name": "iopswriterate", + "name": "limitcpuuse", "required": false, - "type": "long" + "type": "boolean" }, { "description": "the ID of the disk offering to which service offering should be mapped", @@ -116809,141 +117177,114 @@ "type": "uuid" }, { - "description": "burst bytes read rate of the disk offering", + "description": "whether compute offering iops is custom or not", "length": 255, - "name": "bytesreadratemax", + "name": "customizediops", "required": false, - "type": "long" + "since": "4.4", + "type": "boolean" }, { - "description": "burst bytes write rate of the disk offering", + "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", "length": 255, - "name": "byteswriteratemax", + "name": "hypervisorsnapshotreserve", "required": false, - "type": "long" + "since": "4.4", + "type": "integer" }, { - "description": "Lease expiry action, valid values are STOP and DESTROY", + "description": "The minimum number of CPUs to be set with Custom Computer Offering", "length": 255, - "name": "leaseexpiryaction", + "name": "mincpunumber", "required": false, - "since": "4.21.0", - "type": "string" + "since": "4.13", + "type": "integer" }, { - "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", + "description": "the CPU number of the service offering", "length": 255, - "name": "hypervisorsnapshotreserve", + "name": "cpunumber", "required": false, - "since": "4.4", "type": "integer" }, { - "description": "the total memory of the service offering in MB", + "description": "the ID of the vGPU profile to which service offering should be mapped", "length": 255, - "name": "memory", + "name": "vgpuprofileid", + "related": "", "required": false, - "type": "integer" + "since": "4.21", + "type": "uuid" }, { - "description": "details for planner, used to store specific parameters", + "description": "io requests read rate of the disk offering", "length": 255, - "name": "serviceofferingdetails", + "name": "iopsreadrate", "required": false, - "type": "map" + "type": "long" }, { - "description": "The minimum number of CPUs to be set with Custom Computer Offering", + "description": "the ID of the containing domain(s), null for public offerings", "length": 255, - "name": "mincpunumber", + "name": "domainid", + "related": "listDomains,listDomains", "required": false, - "since": "4.13", - "type": "integer" + "type": "list" }, { - "description": "data transfer rate in megabits per second allowed. Supported only for non-System offering and system offerings having \"domainrouter\" systemvmtype", + "description": "VMs using this offering require root volume encryption", "length": 255, - "name": "networkrate", + "name": "encryptroot", "required": false, - "type": "integer" + "since": "4.18", + "type": "boolean" }, { - "description": "length (in seconds) of the burst", + "description": "details for planner, used to store specific parameters", "length": 255, - "name": "iopsreadratemaxlength", + "name": "serviceofferingdetails", "required": false, - "type": "long" + "type": "map" }, { - "description": "The display text of the service offering, defaults to 'name'.", + "description": "Number of days instance is leased for.", "length": 255, - "name": "displaytext", + "name": "leaseduration", "required": false, - "type": "string" + "since": "4.21.0", + "type": "integer" }, { - "description": "Details in key/value pairs using format externaldetails[i].keyname=keyvalue. Example: externaldetails[0].endpoint.url=urlvalue", + "description": "the total memory of the service offering in MB", "length": 255, - "name": "externaldetails", + "name": "memory", "required": false, - "since": "4.21.0", - "type": "map" + "type": "integer" }, { - "description": "min iops of the compute offering", + "description": "length (in seconds) of the burst", "length": 255, - "name": "miniops", + "name": "byteswriteratemaxlength", "required": false, - "since": "4.4", "type": "long" } ], "related": "updateServiceOffering,listServiceOfferings", "response": [ { - "description": "the tags for the service offering", - "name": "storagetags", - "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": "length (in seconds) of the burst", - "name": "diskBytesReadRateMaxLength", - "type": "long" - }, - { - "description": "is this a system vm offering", - "name": "issystem", - "type": "boolean" - }, - { - "description": "name of the disk offering", - "name": "diskofferingname", - "type": "string" - }, - { - "description": "Whether to cleanup VM and its associated resource upon expunge", - "name": "purgeresources", + "description": "true if virtual machine needs to be dynamically scalable of cpu or memory", + "name": "dynamicscalingenabled", "type": "boolean" }, { - "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": "is true if the offering is customized", + "name": "iscustomized", "type": "boolean" }, { - "description": "the name of the gpu card to which service offering is linked", - "name": "gpucardname", - "type": "string" - }, - { - "description": "the maximum number of display heads", - "name": "maxheads", - "type": "long" + "description": "data transfer rate in megabits per second allowed.", + "name": "networkrate", + "type": "integer" }, { "description": "restrict the CPU usage to committed service offering", @@ -116951,18 +117292,13 @@ "type": "boolean" }, { - "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domainid", + "description": "the cache mode to use for this disk offering. none, writeback, writethrough or hypervisor default", + "name": "cacheMode", "type": "string" }, { - "description": "the min iops of the disk offering", - "name": "miniops", - "type": "long" - }, - { - "description": "the id of the service offering", - "name": "id", + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { @@ -116971,64 +117307,48 @@ "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 ID of the disk offering to which service offering is linked", + "name": "diskofferingid", "type": "string" }, { - "description": "io requests write rate of the service offering", - "name": "diskIopsWriteRate", - "type": "long" + "description": "state of the service offering", + "name": "state", + "type": "string" }, { - "description": "Root disk size in GB", - "name": "rootdisksize", - "type": "long" + "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domain", + "type": "string" }, { - "description": "the clock rate CPU speed in Mhz", - "name": "cpuspeed", - "type": "integer" + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", + "type": "string" }, - {}, { - "description": "burst bytes read rate of the disk offering", - "name": "diskBytesReadRateMax", + "description": "the min iops of the disk offering", + "name": "miniops", "type": "long" }, { - "description": "io requests read rate of the service offering", - "name": "diskIopsReadRate", + "description": "the maximum Y resolution", + "name": "maxresolutiony", "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": "an alternate display text of the service offering.", - "name": "displaytext", - "type": "string" - }, - { - "description": "the storage type for this service offering", - "name": "storagetype", - "type": "string" + "description": "length (in seconds) of the burst", + "name": "diskIopsWriteRateMaxLength", + "type": "long" }, { - "description": "bytes read rate of the service offering", - "name": "diskBytesReadRate", - "type": "long" + "description": "true if disk offering uses custom iops, false otherwise", + "name": "iscustomizediops", + "type": "boolean" }, { - "description": "true if virtual machine needs to be dynamically scalable of cpu or memory", - "name": "dynamicscalingenabled", + "description": "is this a system vm offering", + "name": "issystem", "type": "boolean" }, { @@ -117037,28 +117357,23 @@ "type": "boolean" }, { - "description": "the count of GPUs to attach ", - "name": "gpucount", - "type": "integer" + "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": "the number of CPU", + "name": "cpunumber", + "type": "integer" }, { - "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": "burst io requests read rate of the disk offering", - "name": "diskIopsReadRateMax", - "type": "long" - }, - { - "description": "the vsphere storage policy tagged to the service offering in case of VMware", - "name": "vspherestoragepolicy", + "description": "the host tag for the service offering", + "name": "hosttags", "type": "string" }, { @@ -117067,89 +117382,34 @@ "type": "string" }, { - "description": "the ID of the disk offering to which service offering is linked", - "name": "diskofferingid", - "type": "string" - }, - { - "description": "whether GPU device is used for display or not ", - "name": "gpudisplay", + "description": "Whether to cleanup VM and its associated resource upon expunge", + "name": "purgeresources", "type": "boolean" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "is this a the systemvm type for system vm offering", + "name": "systemvmtype", "type": "string" }, - { - "description": "the memory in MB", - "name": "memory", - "type": "integer" - }, { "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": "diskIopsWriteRateMaxLength", - "type": "long" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the maximum Y resolution", - "name": "maxresolutiony", + "description": "the maximum X resolution", + "name": "maxresolutionx", "type": "long" }, { - "description": "true if virtual machine root disk will be encrypted on storage", - "name": "encryptroot", - "type": "boolean" - }, - { - "description": "deployment strategy used to deploy VM.", - "name": "deploymentplanner", + "description": "an alternate display text of the service offering.", + "name": "displaytext", "type": "string" }, { - "description": "true if disk offering uses custom iops, false otherwise", - "name": "iscustomizediops", - "type": "boolean" - }, - { - "description": "length (in second) of the burst", - "name": "diskIopsReadRateMaxLength", - "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": "the name of the service offering", - "name": "name", - "type": "string" + "description": "the memory in MB", + "name": "memory", + "type": "integer" }, { "description": "length (in seconds) of the burst", @@ -117157,473 +117417,311 @@ "type": "long" }, { - "description": "the name of the vgpu profile to which service offering is linked", - "name": "vgpuprofilename", - "type": "string" - }, - { - "description": "Instance lease duration (in days) for service offering", - "name": "leaseduration", + "description": "the count of GPUs to attach ", + "name": "gpucount", "type": "integer" }, { - "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", - "name": "provisioningtype", + "description": "Action to be taken once lease is over", + "name": "leaseexpiryaction", "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 domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domainid", "type": "string" }, { - "description": "burst bytes write rate of the disk offering", - "name": "diskBytesWriteRateMax", - "type": "long" - }, - { - "description": "is this a the systemvm type for system vm offering", - "name": "systemvmtype", - "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": "Action to be taken once lease is over", - "name": "leaseexpiryaction", + "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", + "name": "provisioningtype", "type": "string" }, { - "description": "is this a default system vm offering", - "name": "defaultuse", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the number of CPU", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "bytes write rate of the service offering", - "name": "diskBytesWriteRate", - "type": "long" - }, - { - "description": "the ID of the gpu card to which service offering is linked", - "name": "gpucardid", + "description": "the storage type for this service offering", + "name": "storagetype", "type": "string" }, - {}, - { - "description": "the video RAM size in MB", - "name": "videoram", - "type": "long" - }, { - "description": "the max iops of the disk offering", - "name": "maxiops", + "description": "bytes read rate of the service offering", + "name": "diskBytesReadRate", "type": "long" }, { - "description": "the maximum X resolution", - "name": "maxresolutionx", + "description": "length (in second) of the burst", + "name": "diskIopsReadRateMaxLength", "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", + "description": "whether GPU device is used for display or not ", + "name": "gpudisplay", "type": "boolean" }, { - "description": "state of the service offering", - "name": "state", - "type": "string" - } - ] - }, - { - "description": "Change ownership of a VM from one account to another. This API is available for Basic zones with security groups and Advanced zones with guest networks. A root administrator can reassign a VM from any account to any other account in any domain. A domain administrator can reassign a VM to any account in the same domain.", - "isasync": false, - "name": "assignVirtualMachine", - "params": [ - { - "description": "an optional project for the new VM owner.", - "length": 255, - "name": "projectid", - "related": "", - "required": false, - "type": "uuid" - }, - { - "description": "list of new network ids in which the moved VM will participate. In case no network ids are provided the VM will be part of the default network for that zone. In case there is no network yet created for the new account the default network will be created.", - "length": 255, - "name": "networkids", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", - "required": false, - "type": "list" - }, - { - "description": "id of the VM to be moved", - "length": 255, - "name": "virtualmachineid", - "related": "assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm", - "required": true, - "type": "uuid" - }, - { - "description": "domain id of the new VM owner.", - "length": 255, - "name": "domainid", - "related": "listDomains,listDomains", - "required": false, - "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.", - "length": 255, - "name": "securitygroupids", - "related": "", - "required": false, - "type": "list" - }, - { - "description": "account name of the new VM owner.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - } - ], - "related": "deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm", - "response": [ - { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" - }, - { - "description": "the name of the vgpu profile to which service offering is linked", - "name": "vgpuprofilename", - "type": "string" - }, - { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the project name of the vm", - "name": "project", - "type": "string" - }, - { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "the max iops of the disk offering", + "name": "maxiops", "type": "long" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "the tags for the service offering", + "name": "storagetags", "type": "string" }, + {}, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", + "description": "burst bytes read rate of the disk offering", + "name": "diskBytesReadRateMax", "type": "long" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "the vsphere storage policy tagged to the service offering in case of VMware", + "name": "vspherestoragepolicy", "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": "burst bytes write rate of the disk offering", + "name": "diskBytesWriteRateMax", + "type": "long" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", + "description": "the date this service offering was created", + "name": "created", "type": "date" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" - }, - { - "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 maximum X resolution", - "name": "maxresolutionx", + "description": "bytes write rate of the service offering", + "name": "diskBytesWriteRate", "type": "long" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "the user's name who deployed the virtual machine", - "name": "username", - "type": "string" - }, - { - "description": "the format of the template for the virtual machine", - "name": "templateformat", - "type": "string" - }, - { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", + "description": "is this a default system vm offering", + "name": "defaultuse", "type": "boolean" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", - "type": "string" - }, - { - "description": "Os type ID of the virtual machine", - "name": "guestosid", - "type": "string" + "description": "the clock rate CPU speed in Mhz", + "name": "cpuspeed", + "type": "integer" }, { - "description": "Instance lease expiry date", - "name": "leaseexpirydate", - "type": "date" + "description": "name of the disk offering", + "name": "diskofferingname", + "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zoneid", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", - "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 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 virtual machine root disk will be encrypted on storage", + "name": "encryptroot", + "type": "boolean" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", - "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 control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", + "description": "burst io requests read rate of the disk offering", + "name": "diskIopsReadRateMax", "type": "long" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", + "description": "Root disk size in GB", + "name": "rootdisksize", "type": "long" }, + {}, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" + "description": "length (in seconds) of the burst", + "name": "diskBytesReadRateMaxLength", + "type": "long" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "deployment strategy used to deploy VM.", + "name": "deploymentplanner", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" + "description": "additional key/value details tied with this service offering", + "name": "serviceofferingdetails", + "type": "map" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", + "description": "the video RAM size in MB", + "name": "videoram", "type": "long" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zone", "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": "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 id of the service offering", + "name": "id", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" + "description": "Instance lease duration (in days) for service offering", + "name": "leaseduration", + "type": "integer" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" + "description": "io requests write rate of the service offering", + "name": "diskIopsWriteRate", + "type": "long" }, { - "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": "Change ownership of a VM from one account to another. This API is available for Basic zones with security groups and Advanced zones with guest networks. A root administrator can reassign a VM from any account to any other account in any domain. A domain administrator can reassign a VM to any account in the same domain.", + "isasync": false, + "name": "assignVirtualMachine", + "params": [ + { + "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": "networkids", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", + "required": false, + "type": "list" }, - {}, { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", + "description": "account name of the new VM owner.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" + "description": "domain id of the new VM owner.", + "length": 255, + "name": "domainid", + "related": "listDomains,listDomains", + "required": false, + "type": "uuid" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" + "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": "securitygroupids", + "related": "", + "required": false, + "type": "list" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", - "type": "string" + "description": "id of the VM to be moved", + "length": 255, + "name": "virtualmachineid", + "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,createVMFromBackup,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "required": true, + "type": "uuid" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "an optional project for the new VM owner.", + "length": 255, + "name": "projectid", + "related": "", + "required": false, + "type": "uuid" + } + ], + "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,createVMFromBackup,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "response": [ + { + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "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 gpu card to which service offering is linked", + "name": "gpucardname", + "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": "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": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "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" }, { - "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": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -117632,13 +117730,13 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "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" }, { @@ -117655,352 +117753,208 @@ "type": "set" }, { - "description": "the account associated with the virtual machine", - "name": "account", - "type": "string" - }, - { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", - "type": "string" - }, - { - "description": "Instance lease duration in days", - "name": "leaseduration", - "type": "integer" - }, - { - "description": "device type of the root volume", - "name": "rootdevicetype", - "type": "string" - }, - { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", - "type": "string" - }, - { - "description": "the ID of the vgpu profile to which service offering is linked", - "name": "vgpuprofileid", - "type": "string" - }, - { - "description": "OS name of the vm", - "name": "osdisplayname", - "type": "string" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "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 name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "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": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "the ID of the nic", + "description": "the ID of the affinity group", "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 NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" - }, - { - "description": "the gateway of the nic", - "name": "gateway", + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "the type of the affinity group", + "name": "type", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the account owning the affinity group", + "name": "account", "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 type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the description of the affinity group", + "name": "description", "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 project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", "type": "list" } ], "type": "set" }, { - "description": "CPU arch of the VM", - "name": "arch", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "type": "string" + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", "type": "string" }, { - "description": "Instance lease expiry action", - "name": "leaseexpiryaction", + "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 userdata used for the VM", - "name": "userdataname", - "type": "string" + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, { - "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 ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "Guest vm Boot Type", + "name": "boottype", "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "the account associated with the virtual machine", + "name": "account", "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": "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", + "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": "User VM type", - "name": "vmtype", + "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": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the maximum Y resolution", - "name": "maxresolutiony", - "type": "long" - }, - { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", "type": "boolean" }, + {}, { - "description": "the state of the virtual machine", - "name": "state", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the video RAM size in MB", + "name": "videoram", + "type": "long" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "type": "string" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", + "description": "VNF details", + "name": "vnfdetails", + "type": "map" + }, + { + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "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 group name of the virtual machine", - "name": "group", - "type": "string" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { "description": "the name of the template for the virtual machine", @@ -118008,65 +117962,59 @@ "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "the name of the host for the virtual machine", + "name": "hostname", + "type": "string" }, { - "description": "the 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": "the memory used by the VM in KiB", - "name": "memorykbs", + "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 number of display heads", + "name": "maxheads", + "type": "long" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "OS type id of the vm", + "name": "ostypeid", "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", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "CPU arch of the VM", + "name": "arch", "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", + "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 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": "the password (if exists) of the virtual machine", + "name": "password", + "type": "string" }, { "description": "list of security groups associated with the virtual machine", @@ -118078,32 +118026,22 @@ "type": "string" }, { - "description": "the domain name of the security group", - "name": "domain", + "description": "the account owning the security group", + "name": "account", "type": "string" }, { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", + "description": "the list of egress rules associated with the security group", + "name": "egressrule", "response": [ - { - "description": "the id of the security group rule", - "name": "ruleid", - "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": "account owning the security group rule", - "name": "account", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, { @@ -118111,71 +118049,66 @@ "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "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 project id the tag belongs to", - "name": "projectid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "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": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "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", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { @@ -118183,119 +118116,139 @@ "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 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" + }, + { + "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": "the list of egress rules associated with the security group", - "name": "egressrule", + "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 project name of the group", + "name": "project", + "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", - "type": "string" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "id of the resource", + "name": "resourceid", "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": "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": "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": "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": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag key name", + "name": "key", "type": "string" } ], "type": "set" }, { - "description": "the starting IP of the security group rule", - "name": "startport", + "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" }, { "description": "the code for the ICMP message response", @@ -118303,37 +118256,42 @@ "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": "account owning the security group rule", "name": "account", "type": "string" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" } ], "type": "set" }, { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", + "description": "the domain ID of the security group", + "name": "domainid", "type": "string" }, { "description": "the list of 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", @@ -118344,6 +118302,11 @@ "name": "account", "type": "string" }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, { "description": "resource type", "name": "resourcetype", @@ -118355,13 +118318,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": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -118375,253 +118333,385 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", "type": "string" } ], "type": "set" }, { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "the ID of the security group", - "name": "id", - "type": "string" - }, - { - "description": "the account owning the security group", - "name": "account", - "type": "string" - }, - { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "the project id of the group", - "name": "projectid", + "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 number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" }, { - "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": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the ID of the virtual machine", + "name": "id", + "type": "string" + }, + { + "description": "device ID of the root volume", + "name": "rootdeviceid", + "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 vgpu profile to which service offering is linked", + "name": "vgpuprofilename", + "type": "string" + }, + { + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", + "type": "string" + }, + { + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" + }, + { + "description": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" + }, + { + "description": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" + }, + { + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", + "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": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", "type": "string" }, { - "description": "the video RAM size in MB", - "name": "videoram", + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", "type": "long" }, { - "description": "the maximum number of display heads", - "name": "maxheads", + "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", + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" + }, + { + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "VNF details", - "name": "vnfdetails", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", + "type": "string" + }, + { + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", + "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": "Vm details in key/value pairs.", + "name": "details", "type": "map" }, { - "description": "the name of the gpu card to which service offering is linked", - "name": "gpucardname", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" - } - ], - "since": "3.0.0" - }, - { - "description": "Lists virtual machines on a unmanaged host", - "isasync": false, - "name": "listVmsForImport", - "params": [ + }, { - "description": "hypervisor type of the host", - "length": 255, - "name": "hypervisor", - "required": true, + "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 zone ID", - "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, - "type": "uuid" + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" }, { - "description": "the password for the host", - "length": 255, - "name": "password", - "required": false, + "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": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "the project id of the vm", + "name": "projectid", + "type": "string" }, { - "description": "the host name or IP address", - "length": 255, - "name": "host", - "required": true, + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "the username for the host", - "length": 255, - "name": "username", - "required": false, + "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": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "the VM's primary IP address", + "name": "ipaddress", + "type": "string" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" - } - ], - "related": "listVmwareDcVms,listUnmanagedInstances", - "response": [ + }, {}, { - "description": "the CPU cores per socket for the virtual machine. VMware specific", - "name": "cpucorepersocket", - "type": "integer" + "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 maximum X resolution", + "name": "maxresolutionx", + "type": "long" }, { - "description": "the name of the cluster to which virtual machine belongs", - "name": "clustername", + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", "type": "string" }, { - "description": "indicates the boot type", - "name": "boottype", + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "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", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "the operating system ID of the virtual machine", - "name": "osid", + "description": "User VM type", + "name": "vmtype", "type": "string" }, { - "description": "the list of nics associated with the virtual machine", + "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", + "type": "string" + }, + { + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" + }, + { + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "Instance lease duration in days", + "name": "leaseduration", + "type": "integer" + }, + { + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", + "type": "string" + }, + { + "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": "public IP address id associated with vm via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", + "type": "string" + }, + { + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "the list of nics associated with vm", "name": "nic", "response": [ + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, { "description": "the Secondary ipv4 addr of nic", "name": "secondaryip", "type": "list" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "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", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "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": "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": "the traffic type of the nic", + "name": "traffictype", "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": "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 cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "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": "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": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" }, { "description": "the isolation uri of the nic", @@ -118629,29 +118719,24 @@ "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "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": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "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 isolated private VLAN type if available", @@ -118659,63 +118744,181 @@ "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 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 gateway of IPv6 network", - "name": "ip6gateway", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "the netmask of the nic", + "name": "netmask", "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": "Type of adapter if available", - "name": "adaptertype", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" } ], "type": "set" }, + { + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", + "type": "string" + }, + { + "description": "the count of GPUs on the virtual machine", + "name": "gpucount", + "type": "integer" + }, + { + "description": "the maximum Y resolution", + "name": "maxresolutiony", + "type": "long" + }, + { + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + } + ], + "since": "3.0.0" + }, + { + "description": "Lists virtual machines on a unmanaged host", + "isasync": false, + "name": "listVmsForImport", + "params": [ + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "the host name or IP address", + "length": 255, + "name": "host", + "required": true, + "type": "string" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "the username for the host", + "length": 255, + "name": "username", + "required": false, + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "the password for the host", + "length": 255, + "name": "password", + "required": false, + "type": "string" + }, + { + "description": "the zone ID", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" + }, + { + "description": "hypervisor type of the host", + "length": 255, + "name": "hypervisor", + "required": true, + "type": "string" + } + ], + "related": "listVmwareDcVms,listUnmanagedInstances", + "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the operating system ID of the virtual machine", + "name": "osid", + "type": "string" + }, + { + "description": "the operating system of the virtual machine", + "name": "osdisplayname", + "type": "string" + }, + { + "description": "indicates the boot mode", + "name": "bootmode", + "type": "string" + }, { "description": "the ID of the cluster to which virtual machine belongs", "name": "clusterid", "type": "string" }, + { + "description": "the name of the host to which virtual machine belongs", + "name": "hostname", + "type": "string" + }, { "description": "the list of disks associated with the virtual machine", "name": "disk", @@ -118726,8 +118929,8 @@ "type": "string" }, { - "description": "the controller of the disk", - "name": "controller", + "description": "the ID of the disk", + "name": "id", "type": "string" }, { @@ -118736,13 +118939,8 @@ "type": "integer" }, { - "description": "the capacity of the disk in bytes", - "name": "capacity", - "type": "long" - }, - { - "description": "the ID of the disk", - "name": "id", + "description": "the controller of the disk", + "name": "datastorepath", "type": "string" }, { @@ -118751,13 +118949,23 @@ "type": "string" }, { - "description": "the file path of the disk image", - "name": "imagepath", + "description": "the controller of the disk", + "name": "datastoretype", "type": "string" }, { "description": "the controller of the disk", - "name": "datastoretype", + "name": "controller", + "type": "string" + }, + { + "description": "the capacity of the disk in bytes", + "name": "capacity", + "type": "long" + }, + { + "description": "the file path of the disk image", + "name": "imagepath", "type": "string" }, { @@ -118769,33 +118977,28 @@ "description": "the controller of the disk", "name": "datastorename", "type": "string" - }, - { - "description": "the controller of the disk", - "name": "datastorepath", - "type": "string" } ], "type": "set" }, { - "description": "the name of the host to which virtual machine belongs", - "name": "hostname", - "type": "string" + "description": "the memory of the virtual machine in MB", + "name": "memory", + "type": "integer" }, { - "description": "the ID of the host to which virtual machine belongs", - "name": "hostid", + "description": "the name of the cluster to which virtual machine belongs", + "name": "clustername", "type": "string" }, { - "description": "the operating system of the virtual machine", - "name": "osdisplayname", + "description": "the ID of the host to which virtual machine belongs", + "name": "hostid", "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "indicates the boot type", + "name": "boottype", "type": "string" }, { @@ -118803,27 +119006,195 @@ "name": "cpunumber", "type": "integer" }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the name of the virtual machine", + "name": "name", + "type": "string" + }, { "description": "the power state of the virtual machine", "name": "powerstate", "type": "string" }, { - "description": "the memory of the virtual machine in MB", - "name": "memory", + "description": "the CPU cores per socket for the virtual machine. VMware specific", + "name": "cpucorepersocket", "type": "integer" }, + {}, { "description": "the CPU speed of the virtual machine", "name": "cpuspeed", "type": "integer" }, { - "description": "indicates the boot mode", - "name": "bootmode", - "type": "string" - }, - {} + "description": "the list of nics associated with the virtual machine", + "name": "nic", + "response": [ + { + "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": "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": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "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": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "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 corresponding network", + "name": "networkid", + "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": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "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": "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 isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "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": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + } + ], + "type": "set" + } ], "since": "4.19.0" }, @@ -118832,13 +119203,6 @@ "isasync": true, "name": "configureNetscalerLoadBalancer", "params": [ - { - "description": "true if this netscaler device to dedicated for a account, false if the netscaler device will be shared by multiple accounts", - "length": 255, - "name": "lbdevicededicated", - "required": false, - "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.", "length": 255, @@ -118847,6 +119211,14 @@ "required": false, "type": "list" }, + { + "description": "Netscaler load balancer device ID", + "length": 255, + "name": "lbdeviceid", + "related": "addNetscalerLoadBalancer,configureNetscalerLoadBalancer,registerNetscalerControlCenter,deployNetscalerVpx", + "required": true, + "type": "uuid" + }, { "description": "capacity of the device, Capacity will be interpreted as number of networks device can handle", "length": 255, @@ -118855,73 +119227,80 @@ "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": "true if this netscaler device to dedicated for a account, false if the netscaler device will be shared by multiple accounts", "length": 255, - "name": "inline", + "name": "lbdevicededicated", "required": false, "type": "boolean" }, { - "description": "Netscaler load balancer device ID", + "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": "lbdeviceid", - "related": "addNetscalerLoadBalancer,configureNetscalerLoadBalancer,registerNetscalerControlCenter,deployNetscalerVpx", - "required": true, - "type": "uuid" + "name": "inline", + "required": false, + "type": "boolean" } ], "related": "addNetscalerLoadBalancer,registerNetscalerControlCenter,deployNetscalerVpx", "response": [ { - "description": "the physical network to which this netscaler device belongs to", - "name": "physicalnetworkid", + "description": "device name", + "name": "lbdevicename", "type": "string" }, { - "description": "true if NetScaler device is provisioned to be a GSLB service provider", - "name": "gslbprovider", - "type": "boolean" + "description": "device capacity", + "name": "lbdevicecapacity", + "type": "long" }, - {}, { - "description": "the private interface of the load balancer", - "name": "privateinterface", + "description": "public IP of the NetScaler representing GSLB site", + "name": "gslbproviderpublicip", "type": "string" }, { - "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": "the management IP address of the external load balancer", - "name": "ipaddress", + "description": "device id of the netscaler load balancer", + "name": "lbdeviceid", "type": "string" }, { - "description": "private IP of the NetScaler representing GSLB site", - "name": "gslbproviderprivateip", - "type": "string" + "description": "Used when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device.", + "name": "podids", + "type": "list" }, { - "description": "public IP of the NetScaler representing GSLB site", - "name": "gslbproviderpublicip", + "description": "true if NetScaler device is provisioned to be a GSLB service provider", + "name": "gslbprovider", + "type": "boolean" + }, + { + "description": "name of the provider", + "name": "provider", "type": "string" }, - {}, { "description": "true if device is dedicated for an account", "name": "lbdevicededicated", "type": "boolean" }, { - "description": "name of the provider", - "name": "provider", + "description": "the management IP address of the external load balancer", + "name": "ipaddress", "type": "string" }, { - "description": "device id of the netscaler load balancer", - "name": "lbdeviceid", + "description": "the physical network to which this netscaler device belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "the private interface of the load balancer", + "name": "privateinterface", "type": "string" }, { @@ -118929,35 +119308,27 @@ "name": "jobid", "type": "string" }, + {}, { - "description": "device name", - "name": "lbdevicename", - "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": "Used when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device.", - "name": "podids", - "type": "list" - }, - { - "description": "true if NetScaler device is provisioned exclusively to be a GSLB service provider", - "name": "isexclusivegslbprovider", - "type": "boolean" - }, - { - "description": "device capacity", - "name": "lbdevicecapacity", - "type": "long" + "description": "private IP of the NetScaler representing GSLB site", + "name": "gslbproviderprivateip", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "device state", + "name": "lbdevicestate", + "type": "string" } ] }, @@ -118983,17 +119354,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", @@ -119004,7 +119371,11 @@ "name": "displaytext", "type": "string" }, - {} + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } ] }, { @@ -119013,24 +119384,32 @@ "name": "addObjectStoragePool", "params": [ { - "description": "the object store provider name", - "length": 255, - "name": "provider", + "description": "the URL for the object store", + "length": 2048, + "name": "url", "required": true, "type": "string" }, { - "description": "the name for the object store", + "description": "the tags for the storage pool", "length": 255, - "name": "name", - "required": true, + "name": "tags", + "required": false, "type": "string" }, { - "description": "the tags for the storage pool", + "description": "the total size of the object store in GiB. Used for tracking capacity and sending alerts", "length": 255, - "name": "tags", + "name": "size", "required": false, + "since": "4.21", + "type": "long" + }, + { + "description": "the name for the object store", + "length": 255, + "name": "name", + "required": true, "type": "string" }, { @@ -119041,43 +119420,18 @@ "type": "map" }, { - "description": "the total size of the object store in GiB. Used for tracking capacity and sending alerts", + "description": "the object store provider name", "length": 255, - "name": "size", - "required": false, - "since": "4.21", - "type": "long" - }, - { - "description": "the URL for the object store", - "length": 2048, - "name": "url", + "name": "provider", "required": true, "type": "string" } ], "related": "", "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": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, { - "description": "the ID of the object store", - "name": "id", + "description": "the url of the object store", + "name": "url", "type": "string" }, { @@ -119091,9 +119445,14 @@ "type": "integer" }, { - "description": "the url of the object store", - "name": "url", - "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" }, { "description": "the allocated size of the object store", @@ -119101,14 +119460,26 @@ "type": "long" }, { - "description": "the name of the object store", - "name": "name", + "description": "the ID of the object store", + "name": "id", "type": "string" }, { - "description": "the total size of the object store", - "name": "storagetotal", + "description": "the object store currently used size", + "name": "storageused", "type": "long" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, + { + "description": "the name of the object store", + "name": "name", + "type": "string" } ], "since": "4.19.0" @@ -119136,27 +119507,27 @@ } ], "response": [ - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, - {}, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" + }, + {}, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" } ], "since": "4.15.0" @@ -119170,12 +119541,22 @@ "description": "the ID of the network service provider", "length": 255, "name": "id", - "related": "listTrafficTypes", + "related": "", "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", @@ -119187,17 +119568,7 @@ "name": "jobid", "type": "string" }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } + {} ], "since": "3.0.0" }, @@ -119207,25 +119578,25 @@ "name": "listNetworkDevice", "params": [ { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "", + "description": "parameters for network device", "length": 255, - "name": "page", + "name": "networkdeviceparameterlist", "required": false, - "type": "integer" + "type": "map" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { "description": "Network device type, now supports ExternalDhcp, PxeServer, NetscalerMPXLoadBalancer, NetscalerVPXLoadBalancer, NetscalerSDXLoadBalancer, F5BigIpLoadBalancer, JuniperSRXFirewall, PaloAltoFirewall", @@ -119235,31 +119606,31 @@ "type": "string" }, { - "description": "parameters for network device", + "description": "", "length": 255, - "name": "networkdeviceparameterlist", + "name": "page", "required": false, - "type": "map" + "type": "integer" } ], "related": "addNetworkDevice", "response": [ { - "description": "the ID of the network device", - "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 network device", + "name": "id", + "type": "string" } ] }, @@ -119269,12 +119640,11 @@ "name": "listProjectRoles", "params": [ { - "description": "List project role by project role ID.", + "description": "", "length": 255, - "name": "projectroleid", - "related": "listProjectRoles,updateProjectRole", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { "description": "List project role by project role name.", @@ -119284,11 +119654,12 @@ "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.", @@ -119316,41 +119687,41 @@ "related": "updateProjectRole", "response": [ { - "description": "the id of the project", - "name": "projectid", + "description": "the description of the role", + "name": "description", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the role", + "name": "id", + "type": "string" + }, + { + "description": "the id of the project", + "name": "projectid", "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the name of the role", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "the ID of the role", - "name": "id", + "description": "the name of the role", + "name": "name", "type": "string" }, - {}, { "description": "Indicates whether the role will be visible to all users (public) or only to root admins (private). If this parameter is not specified during the creation of the role its value will be defaulted to true (public).", "name": "ispublic", "type": "boolean" - }, - { - "description": "the description of the role", - "name": "description", - "type": "string" } ], "since": "4.15.0" @@ -119371,9 +119742,11 @@ ], "related": "", "response": [ + {}, + {}, { - "description": "the username to authenticate to the controller", - "name": "username", + "description": "the name assigned to the controller", + "name": "name", "type": "string" }, { @@ -119381,33 +119754,31 @@ "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", "type": "string" }, - {}, { "description": "the url of the controller api", "name": "url", "type": "string" }, { - "description": "device id of the controller", - "name": "id", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the username to authenticate to the controller", + "name": "username", "type": "string" }, { - "description": "the name assigned to the controller", - "name": "name", + "description": "device id of the controller", + "name": "id", "type": "string" - }, - {} + } ] }, { @@ -119416,9 +119787,9 @@ "name": "updateTemplate", "params": [ { - "description": "the display text of the image", - "length": 4096, - "name": "displaytext", + "description": "the format for the image", + "length": 255, + "name": "format", "required": false, "type": "string" }, @@ -119430,42 +119801,33 @@ "type": "boolean" }, { - "description": "indicates that the template can be used for deployment of CKS clusters", + "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": "forcks", + "name": "forceupdateostype", "required": false, - "since": "4.21.0", + "since": "4.21", "type": "boolean" }, { - "description": "the ID of the OS type that best represents the OS of this image.", + "description": "the name of the image file", "length": 255, - "name": "ostypeid", - "related": "addGuestOs", + "name": "name", "required": false, - "type": "uuid" - }, - { - "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", - "required": true, - "type": "uuid" + "type": "string" }, { - "description": "sort key of the template, integer", + "description": "the type of the template. Valid options are: USER/VNF (for all users) and SYSTEM/ROUTING/BUILTIN (for admins only).", "length": 255, - "name": "sortkey", + "name": "templatetype", "required": false, - "type": "integer" + "type": "string" }, { - "description": "Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", + "description": "true if the template requires HVM, false otherwise; available only for updateTemplate API", "length": 255, - "name": "details", + "name": "requireshvm", "required": false, - "type": "map" + "type": "boolean" }, { "description": "true if template/ISO contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", @@ -119475,32 +119837,25 @@ "type": "boolean" }, { - "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": "true if the template requires HVM, false otherwise; available only for updateTemplate API", + "description": "indicates that the template can be used for deployment of CKS clusters", "length": 255, - "name": "requireshvm", + "name": "forcks", "required": false, + "since": "4.21.0", "type": "boolean" }, { - "description": "the format for the image", + "description": "Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", "length": 255, - "name": "format", + "name": "details", "required": false, - "type": "string" + "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.", + "description": "true if image is bootable, false otherwise; available only for updateIso API", "length": 255, - "name": "forceupdateostype", + "name": "bootable", "required": false, - "since": "4.21", "type": "boolean" }, { @@ -119512,33 +119867,49 @@ "type": "string" }, { - "description": "true if the image supports the password reset feature; default is false", + "description": "the display text of the image", + "length": 4096, + "name": "displaytext", + "required": false, + "type": "string" + }, + { + "description": "the ID of the OS type that best represents the OS of this image.", "length": 255, - "name": "passwordenabled", + "name": "ostypeid", + "related": "addGuestOs", "required": false, - "type": "boolean" + "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": "sort key of the template, integer", "length": 255, - "name": "cleanupdetails", + "name": "sortkey", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "the type of the template. Valid options are: USER/VNF (for all users) and SYSTEM/ROUTING/BUILTIN (for admins only).", + "description": "true if the image supports the password reset feature; default is false", "length": 255, - "name": "templatetype", + "name": "passwordenabled", "required": false, - "type": "string" + "type": "boolean" }, { - "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": "the ID of the image file", + "length": 255, + "name": "id", + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,listIsos,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "required": true, + "type": "uuid" + }, { "description": "the CPU arch of the template/ISO. Valid options are: x86_64, aarch64", "length": 255, @@ -119548,48 +119919,92 @@ "type": "string" }, { - "description": "the name of the image file", + "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": "name", + "name": "cleanupdetails", "required": false, - "type": "string" + "type": "boolean" } ], - "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": "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", + "type": "boolean" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" + }, + { + "description": "the date this template was created", + "name": "created", + "type": "date" + }, + { + "description": "the size of the template", + "name": "size", + "type": "long" + }, + { + "description": "the name of the domain to which the template belongs", + "name": "domain", + "type": "string" + }, + { + "description": "the id of userdata linked to this template", + "name": "userdataid", "type": "string" }, + { + "description": "the status of the template", + "name": "status", + "type": "string" + }, + { + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", + "type": "boolean" + }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "description": "id of the resource", + "name": "resourceid", "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 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 ID of the domain associated with the tag", - "name": "domainid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -119598,77 +120013,88 @@ "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 key name", + "name": "key", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], "type": "set" }, { - "description": "the project id of the template", - "name": "projectid", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" + "description": "the account name to which the template belongs", + "name": "account", + "type": "string" }, { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" + "description": "the type of the template", + "name": "templatetype", + "type": "string" }, { "description": "the processor bit size", "name": "bits", "type": "int" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the name of the OS type for this template.", "name": "ostypename", "type": "string" }, { - "description": "path of the Domain the template belongs to", - "name": "domainpath", + "description": "The name of extension linked to this template", + "name": "extensionname", "type": "string" }, + {}, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "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 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": "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": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", @@ -119676,109 +120102,84 @@ "type": "string" }, { - "description": "the ID of the zone for this template", - "name": "zoneid", - "type": "string" + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", + "type": "boolean" }, { - "description": "the template ID", - "name": "id", + "description": "the name of the secondary storage host for the template", + "name": "hostname", "type": "string" }, { - "description": "the name of the domain to which the template belongs", - "name": "domain", - "type": "string" + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", + "type": "boolean" }, { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", + "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": "additional key/value details tied with template", + "name": "details", + "type": "map" }, { - "description": "the project name of the template", - "name": "project", + "description": "The ID of extension linked to this template", + "name": "extensionid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", - "type": "boolean" + "description": "the name of the zone for this template", + "name": "zonename", + "type": "string" }, { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", + "description": "If true it indicates that the template can be used for CKS cluster deployments", + "name": "forcks", "type": "boolean" }, + {}, { - "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 account id to which the template belongs", - "name": "accountid", + "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 tag of this template", "name": "templatetag", "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": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", "type": "boolean" }, { - "description": "the physical size of the template", - "name": "physicalsize", - "type": "long" - }, - { - "description": "the name of the secondary storage host for the template", - "name": "hostname", - "type": "string" - }, - { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "checksum of the template", + "name": "checksum", "type": "string" }, { - "description": "the name of the zone for this template", - "name": "zonename", + "description": "the ID of the OS type for this template.", + "name": "ostypeid", "type": "string" }, { - "description": "The ID of extension linked to this template", - "name": "extensionid", - "type": "string" + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" }, { - "description": "the date this template was created", - "name": "created", + "description": "the date this template was removed", + "name": "removed", "type": "date" }, { @@ -119787,38 +120188,28 @@ "type": "string" }, { - "description": "the status of the template", - "name": "status", + "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": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", - "type": "boolean" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the size of the template", - "name": "size", - "type": "long" + "description": "the template display text", + "name": "displaytext", + "type": "string" }, { - "description": "the template name", - "name": "name", + "description": "the template ID", + "name": "id", "type": "string" }, { - "description": "the account name to which the template belongs", - "name": "account", + "description": "the account id to which the template belongs", + "name": "accountid", "type": "string" }, { @@ -119827,89 +120218,69 @@ "type": "boolean" }, { - "description": "the type of the template", - "name": "templatetype", - "type": "string" - }, - { - "description": "the template display text", - "name": "displaytext", - "type": "string" - }, - { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "name": "isdynamicallyscalable", "type": "boolean" }, - {}, { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", "type": "boolean" }, { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", - "type": "string" - }, - { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", "type": "boolean" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "The name of extension linked to this template", - "name": "extensionname", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", - "type": "map" + "description": "the ID of the zone for this template", + "name": "zoneid", + "type": "string" }, { - "description": "the date this template was removed", - "name": "removed", - "type": "date" + "description": "the template name", + "name": "name", + "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" }, { - "description": "CPU Arch of the template", - "name": "arch", - "type": "string" + "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": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project name of the template", + "name": "project", "type": "string" }, + {}, { - "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 id of userdata linked to this template", - "name": "userdataid", + "description": "the project id of the template", + "name": "projectid", "type": "string" }, { - "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", - "name": "deployasis", + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", "type": "boolean" } ] @@ -119920,30 +120291,46 @@ "name": "createVlanIpRange", "params": [ { - "description": "the netmask of the VLAN IP range", + "description": "the ending IPv6 address in the IPv6 network range", "length": 255, - "name": "netmask", + "name": "endipv6", "required": false, "type": "string" }, { - "description": "the gateway of the VLAN IP range", + "description": "domain ID of the account owning a VLAN", "length": 255, - "name": "gateway", + "name": "domainid", + "related": "listDomains,listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "Provider name for which the IP range is reserved for", + "length": 255, + "name": "provider", "required": false, + "since": "4.21.0", "type": "string" }, { - "description": "true if IP range is set to system vms, false if not", + "description": "true if VLAN is of Virtual type, false if Direct", "length": 255, - "name": "forsystemvms", + "name": "forvirtualnetwork", "required": false, "type": "boolean" }, { - "description": "the ending IPv6 address in the IPv6 network 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": "endipv6", + "name": "vlan", + "required": false, + "type": "string" + }, + { + "description": "the gateway of the IPv6 network. Required for Shared networks and Isolated networks when it belongs to VPC", + "length": 255, + "name": "ip6gateway", "required": false, "type": "string" }, @@ -119964,34 +120351,26 @@ "type": "uuid" }, { - "description": "the gateway of the IPv6 network. Required for Shared networks and Isolated networks when it belongs to VPC", + "description": "the physical network id", "length": 255, - "name": "ip6gateway", + "name": "physicalnetworkid", + "related": "", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "account who will own the VLAN. If VLAN is Zone wide, this parameter should be omitted", + "description": "the ending IP address in the VLAN IP range", "length": 255, - "name": "account", + "name": "endip", "required": false, "type": "string" }, { - "description": "domain ID of the account owning a VLAN", - "length": 255, - "name": "domainid", - "related": "listDomains,listDomains", - "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,47 +120381,47 @@ "type": "uuid" }, { - "description": "the ending IP address in the VLAN IP range", + "description": "the beginning IPv6 address in the IPv6 network range", "length": 255, - "name": "endip", + "name": "startipv6", "required": false, "type": "string" }, { - "description": "true if VLAN is of Virtual type, false if Direct", + "description": "the netmask of the VLAN IP range", "length": 255, - "name": "forvirtualnetwork", + "name": "netmask", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "the beginning IPv6 address in the IPv6 network range", + "description": "account who will own the VLAN. If VLAN is Zone wide, this parameter should be omitted", "length": 255, - "name": "startipv6", + "name": "account", "required": false, "type": "string" }, { - "description": "Provider name for which the IP range is reserved for", + "description": "the gateway of the VLAN IP range", "length": 255, - "name": "provider", + "name": "gateway", "required": false, - "since": "4.21.0", "type": "string" }, { - "description": "the beginning IP address in the VLAN IP range", + "description": "true if IP range is set to system vms, false if not", "length": 255, - "name": "startip", + "name": "forsystemvms", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "the 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 Zone ID of the VLAN IP range", "length": 255, - "name": "vlan", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "string" + "type": "uuid" }, { "description": "the CIDR of IPv6 network, must be at least /64", @@ -120050,56 +120429,50 @@ "name": "ip6cidr", "required": false, "type": "string" - }, - { - "description": "the physical network id", - "length": 255, - "name": "physicalnetworkid", - "related": "", - "required": false, - "type": "uuid" } ], "related": "updateVlanIpRange", "response": [ + {}, { - "description": "the Pod name for the VLAN IP range", - "name": "podname", + "description": "indicates to which provider the IP range is dedicated to", + "name": "provider", "type": "string" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the netmask of the VLAN IP range", + "name": "netmask", + "type": "string" }, { - "description": "the cidr of the VLAN IP range", - "name": "cidr", + "description": "the domain ID of the VLAN IP range", + "name": "domainid", "type": "string" }, { - "description": "the domain name of the VLAN IP range", - "name": "domain", + "description": "the end ip of the VLAN IP range", + "name": "endip", "type": "string" }, { - "description": "the ID of the VLAN IP range", - "name": "id", + "description": "the description of the VLAN IP range", + "name": "description", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain name of the VLAN IP range", + "name": "domain", "type": "string" }, { - "description": "the network id of vlan range", - "name": "networkid", + "description": "the project name of the vlan range", + "name": "project", "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" }, { @@ -120108,49 +120481,48 @@ "type": "string" }, { - "description": "the start ipv6 of the VLAN IP range", - "name": "startipv6", + "description": "the ID of the VLAN IP range", + "name": "id", "type": "string" }, { - "description": "the virtual network for the VLAN IP range", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "the Pod name for the VLAN IP range", + "name": "podname", + "type": "string" }, - {}, { - "description": "the start ip of the VLAN IP range", - "name": "startip", + "description": "the gateway of the VLAN IP range", + "name": "gateway", "type": "string" }, { - "description": "the Pod ID for the VLAN IP range", - "name": "podid", + "description": "the Zone ID of the VLAN IP range", + "name": "zoneid", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the start ip of the VLAN IP range", + "name": "startip", "type": "string" }, { - "description": "the end ipv6 of the VLAN IP range", - "name": "endipv6", + "description": "the start ipv6 of the VLAN IP range", + "name": "startipv6", "type": "string" }, { - "description": "the gateway of the VLAN IP range", - "name": "gateway", + "description": "the network id of vlan range", + "name": "networkid", "type": "string" }, { - "description": "the account of the VLAN IP range", - "name": "account", - "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 cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { @@ -120159,51 +120531,50 @@ "type": "string" }, { - "description": "the end ip of the VLAN IP range", - "name": "endip", - "type": "string" + "description": "the virtual network for the VLAN IP range", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "the ID or VID of the VLAN.", - "name": "vlan", + "description": "the cidr of the VLAN IP range", + "name": "cidr", "type": "string" }, { - "description": "indicates whether VLAN IP range is dedicated to system vms or not", - "name": "forsystemvms", - "type": "boolean" + "description": "the end ipv6 of the VLAN IP range", + "name": "endipv6", + "type": "string" }, { - "description": "the netmask of the VLAN IP range", - "name": "netmask", + "description": "the Pod ID for the VLAN IP range", + "name": "podid", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the account of the VLAN IP range", + "name": "account", "type": "string" }, { - "description": "indicates to which provider the IP range is dedicated to", - "name": "provider", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the project name of the vlan range", - "name": "project", + "description": "the ID or VID of the VLAN.", + "name": "vlan", "type": "string" }, { - "description": "the Zone ID of the VLAN IP range", - "name": "zoneid", - "type": "string" + "description": "indicates whether VLAN IP range is dedicated to system vms or not", + "name": "forsystemvms", + "type": "boolean" }, { - "description": "the description of the VLAN IP range", - "name": "description", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" - }, - {} + } ] }, { @@ -120220,63 +120591,63 @@ "type": "uuid" }, { - "description": "an optional field, whether to the display the vpn 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": "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 vpn 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 project id", - "name": "projectid", - "type": "string" - }, - { - "description": "the owner", - "name": "account", + "description": "the public IP address", + "name": "publicip", "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": "Split multiple remote networks into multiple phase 2 SAs. Often used with Cisco some products.", "name": "splitconnections", "type": "boolean" }, + { + "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", "type": "boolean" }, { - "description": "the domain id of the owner", - "name": "domainid", - "type": "string" + "description": "the date and time the host was created", + "name": "created", + "type": "date" }, { - "description": "Lifetime of IKE SA of customer gateway", - "name": "ikelifetime", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "the domain name of the owner", - "name": "domain", + "description": "the owner", + "name": "account", "type": "string" }, { @@ -120285,38 +120656,38 @@ "type": "string" }, { - "description": "public ip address id of the customer gateway", - "name": "gateway", + "description": "State of vpn connection", + "name": "state", "type": "string" }, { - "description": "the domain path of the owner", - "name": "domainpath", + "description": "the domain name of the owner", + "name": "domain", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "IPsec Preshared-Key of the customer gateway", + "name": "ipsecpsk", + "type": "string" }, { - "description": "the vpn gateway ID", - "name": "s2svpngatewayid", + "description": "public ip address id of the customer gateway", + "name": "gateway", "type": "string" }, { - "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", - "name": "ikeversion", + "description": "the customer gateway ID", + "name": "s2scustomergatewayid", "type": "string" }, { - "description": "the project name", - "name": "project", - "type": "string" + "description": "if DPD is enabled for customer gateway", + "name": "dpd", + "type": "boolean" }, { - "description": "the date and time the host was created", - "name": "created", + "description": "the date and time the host was removed", + "name": "removed", "type": "date" }, { @@ -120324,61 +120695,61 @@ "name": "fordisplay", "type": "boolean" }, - {}, { - "description": "Lifetime of ESP SA of customer gateway", - "name": "esplifetime", - "type": "long" + "description": "the project name", + "name": "project", + "type": "string" }, { - "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the domain path of the owner", + "name": "domainpath", "type": "string" }, { - "description": "if DPD is enabled for customer gateway", - "name": "dpd", - "type": "boolean" + "description": "Lifetime of IKE SA of customer gateway", + "name": "ikelifetime", + "type": "long" }, { - "description": "the public IP address", - "name": "publicip", + "description": "ESP policy of the customer gateway", + "name": "esppolicy", "type": "string" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", + "type": "string" }, + {}, { - "description": "State of vpn connection", - "name": "state", - "type": "string" + "description": "Lifetime of ESP SA of customer gateway", + "name": "esplifetime", + "type": "long" }, { - "description": "the customer gateway ID", - "name": "s2scustomergatewayid", + "description": "the domain id of the owner", + "name": "domainid", "type": "string" }, { - "description": "IPsec Preshared-Key of the customer gateway", - "name": "ipsecpsk", + "description": "the project id", + "name": "projectid", "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 vpn gateway ID", + "name": "s2svpngatewayid", "type": "string" }, { - "description": "State of vpn connection", - "name": "passive", - "type": "boolean" + "description": "IKE policy of the customer gateway", + "name": "ikepolicy", + "type": "string" } ], "since": "4.4" @@ -120396,13 +120767,6 @@ "required": true, "type": "uuid" }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, { "description": "", "length": 255, @@ -120416,37 +120780,119 @@ "name": "page", "required": false, "type": "integer" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" } ], "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork", "response": [ { - "description": "the traffic type of the network", - "name": "traffictype", + "description": "the ID of the Network associated with this private gateway", + "name": "associatednetworkid", "type": "string" }, { - "description": "the id of the network", - "name": "id", + "description": "the displaytext of the network", + "name": "displaytext", "type": "string" }, { - "description": "The internet protocol of network offering", - "name": "internetprotocol", + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "path of the Domain the network belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "the project id of the ipaddress", + "name": "projectid", + "type": "string" + }, + { + "description": "ACL Id associated with the VPC network", + "name": "aclid", + "type": "string" + }, + { + "description": "The Ipv6 routing type of network offering", + "name": "ip6routing", + "type": "string" + }, + { + "description": "MTU configured on the network VR's private interfaces", + "name": "privatemtu", + "type": "integer" + }, + { + "description": "true if network offering is ip conserve mode enabled", + "name": "networkofferingconservemode", + "type": "boolean" + }, + { + "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": "true if network is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the name of the Network associated with this private gateway", + "name": "associatednetwork", + "type": "string" + }, + { + "description": "the first IPv6 DNS for the network", + "name": "ip6dns1", + "type": "string" + }, + { + "description": "the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE", + "name": "networkcidr", + "type": "string" + }, + { + "description": "the owner of the network", + "name": "account", "type": "string" }, + { + "description": "the details of the network", + "name": "details", + "type": "map" + }, { "description": "the list of resource tags associated with network", "name": "tags", "response": [ { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -120455,61 +120901,121 @@ "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": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "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": "tag key name", + "name": "key", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" } ], "type": "list" }, { - "description": "the ID of the Network associated with this private gateway", - "name": "associatednetworkid", + "description": "true if network supports specifying ip ranges, false otherwise", + "name": "specifyipranges", + "type": "boolean" + }, + { + "description": "the name of the network", + "name": "name", "type": "string" }, { - "description": "availability of the network offering the network is created from", - "name": "networkofferingavailability", + "description": "the type of the network", + "name": "type", "type": "string" }, { - "description": "path of the Domain the network belongs to", - "name": "domainpath", + "description": "the date this network was created", + "name": "created", + "type": "date" + }, + { + "description": "the network domain", + "name": "networkdomain", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "VPC the network belongs to", + "name": "vpcid", + "type": "string" + }, + { + "description": "the second IPv4 DNS for the network", + "name": "dns2", + "type": "string" + }, + { + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip4routes", + "type": "set" + }, + { + "description": "network offering id the network is created from", + "name": "networkofferingid", + "type": "string" + }, + { + "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 if network supports specifying vlan, false otherwise", + "name": "specifyvlan", + "type": "boolean" + }, + { + "description": "the first IPv4 DNS for the network", + "name": "dns1", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { @@ -120526,8 +121032,8 @@ "name": "provider", "response": [ { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", + "description": "state of the network provider", + "name": "state", "type": "string" }, { @@ -120536,14 +121042,14 @@ "type": "boolean" }, { - "description": "state of the network provider", - "name": "state", + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", "type": "string" }, { - "description": "services for this provider", - "name": "servicelist", - "type": "list" + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" }, { "description": "the provider name", @@ -120551,13 +121057,13 @@ "type": "string" }, { - "description": "uuid of the network provider", - "name": "id", - "type": "string" + "description": "services for this provider", + "name": "servicelist", + "type": "list" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "uuid of the network provider", + "name": "id", "type": "string" } ], @@ -120589,53 +121095,48 @@ "type": "list" }, { - "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", + "type": "boolean" }, { - "description": "The IPv4 routing type of network", - "name": "ip4routing", + "description": "the domain name of the network owner", + "name": "domain", "type": "string" }, { - "description": "the owner of the network", - "name": "account", + "description": "The internet protocol of network offering", + "name": "internetprotocol", "type": "string" }, { - "description": "Name of the VPC to which this network belongs", - "name": "vpcname", + "description": "name of the network offering the network is created from", + "name": "networkofferingname", "type": "string" }, { - "description": "the first IPv4 DNS for the network", - "name": "dns1", + "description": "The IPv4 routing type of network", + "name": "ip4routing", "type": "string" }, { - "description": "Tungsten-Fabric virtual router the network belongs to", - "name": "tungstenvirtualrouteruuid", + "description": "The external id of the network", + "name": "externalid", "type": "string" }, { - "description": "true if network supports specifying ip ranges, false otherwise", - "name": "specifyipranges", - "type": "boolean" - }, - { - "description": "true network requires restart", - "name": "restartrequired", - "type": "boolean" + "description": "The vlan of the network. This parameter is visible to ROOT admins only", + "name": "vlan", + "type": "string" }, { - "description": "the physical network id", - "name": "physicalnetworkid", + "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", + "name": "cidr", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", + "name": "broadcasturi", "type": "string" }, { @@ -120643,184 +121144,114 @@ "name": "project", "type": "string" }, - { - "description": "name of the network offering the network is created from", - "name": "networkofferingname", - "type": "string" - }, { "description": "true if network is system, false otherwise", "name": "issystem", "type": "boolean" }, { - "description": "true if network can span multiple zones", - "name": "strechedl2subnet", - "type": "boolean" - }, - { - "description": "true if network supports specifying vlan, false otherwise", - "name": "specifyvlan", - "type": "boolean" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "MTU configured on the network VR's private interfaces", - "name": "privatemtu", - "type": "integer" + "description": "the 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 physical network id", + "name": "physicalnetworkid", "type": "string" }, { - "description": "ACL Id associated with the VPC network", - "name": "aclid", - "type": "string" + "description": "The BGP peers for the network", + "name": "bgppeers", + "type": "set" }, { - "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": "Broadcast domain type of the network", "name": "broadcastdomaintype", "type": "string" }, - { - "description": "the date this network was created", - "name": "created", - "type": "date" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", - "name": "cidr", - "type": "string" - }, - { - "description": "display text of the network offering the network is created from", - "name": "networkofferingdisplaytext", - "type": "string" - }, - { - "description": "the displaytext of the network", - "name": "displaytext", + "description": "the name of the zone the network belongs to", + "name": "zonename", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "ACL name associated with the VPC network", + "name": "aclname", "type": "string" }, { - "description": "state of the network", - "name": "state", + "description": "UUID of AS NUMBER", + "name": "asnumberid", "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", - "type": "string" - }, - { - "description": "the second IPv6 DNS for the network", - "name": "ip6dns2", - "type": "string" - }, - { - "description": "The Ipv6 routing type of network offering", - "name": "ip6routing", + "description": "Tungsten-Fabric virtual router the network belongs to", + "name": "tungstenvirtualrouteruuid", "type": "string" }, { - "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", - "name": "broadcasturi", + "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 routes for the network to ease adding route in upstream router", - "name": "ip6routes", - "type": "set" - }, - { - "description": "MTU configured on the network VR's public facing interfaces", - "name": "publicmtu", - "type": "integer" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, { "description": "list networks available for vm deployment", "name": "canusefordeploy", "type": "boolean" }, { - "description": "true if network is default, false otherwise", - "name": "isdefault", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "related to what other network configuration", + "name": "related", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" + "description": "AS NUMBER", + "name": "asnumber", + "type": "long" }, { - "description": "The BGP peers for the network", - "name": "bgppeers", + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", "type": "set" }, { - "description": "the first IPv6 DNS for the network", - "name": "ip6dns1", + "description": "zone id of the network", + "name": "zoneid", "type": "string" }, { - "description": "the network's gateway", - "name": "gateway", - "type": "string" + "description": "true if network can span multiple zones", + "name": "strechedl2subnet", + "type": "boolean" }, { - "description": "the network's netmask", - "name": "netmask", - "type": "string" + "description": "if network offering supports vm autoscaling feature", + "name": "supportsvmautoscaling", + "type": "boolean" }, { - "description": "network offering id the network is created from", - "name": "networkofferingid", + "description": "Name of the VPC to which this network belongs", + "name": "vpcname", "type": "string" }, { @@ -120828,121 +121259,61 @@ "name": "acltype", "type": "string" }, - { - "description": "zone id of the network", - "name": "zoneid", - "type": "string" - }, - { - "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": "an optional field, whether to the display the network to the end user or not.", "name": "displaynetwork", "type": "boolean" }, - {}, - { - "description": "true if users from subdomains can access the domain level network", - "name": "subdomainaccess", - "type": "boolean" - }, { - "description": "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": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "the name of the network", - "name": "name", + "description": "the network's netmask", + "name": "netmask", "type": "string" }, { - "description": "the domain name of the network owner", - "name": "domain", + "description": "the traffic type of the network", + "name": "traffictype", "type": "string" }, { - "description": "list networks that are persistent", - "name": "ispersistent", - "type": "boolean" - }, - { - "description": "The vlan of the network. This parameter is visible to ROOT admins only", - "name": "vlan", + "description": "availability of the network offering the network is created from", + "name": "networkofferingavailability", "type": "string" }, { - "description": "AS NUMBER", - "name": "asnumber", - "type": "long" - }, - { - "description": "the type of the network", - "name": "type", + "description": "the id of the network", + "name": "id", "type": "string" }, { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip4routes", - "type": "set" + "description": "If the network has redundant routers enabled", + "name": "redundantrouter", + "type": "boolean" }, { - "description": "VPC the network belongs to", - "name": "vpcid", + "description": "the domain id of the network owner", + "name": "domainid", "type": "string" }, - { - "description": "if network offering supports vm autoscaling feature", - "name": "supportsvmautoscaling", - "type": "boolean" - }, - {}, { "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", "name": "zonesnetworkspans", "type": "set" }, + {}, { - "description": "ACL name associated with the VPC network", - "name": "aclname", - "type": "string" - }, - { - "description": "the name of the zone the network belongs to", - "name": "zonename", - "type": "string" - }, - { - "description": "UUID of AS NUMBER", - "name": "asnumberid", - "type": "string" - }, - { - "description": "the domain id of the network owner", - "name": "domainid", - "type": "string" - }, - { - "description": "related to what other network configuration", - "name": "related", - "type": "string" + "description": "list networks that are persistent", + "name": "ispersistent", + "type": "boolean" }, + {}, { - "description": "the name of the Network associated with this private gateway", - "name": "associatednetwork", + "description": "display text of the network offering the network is created from", + "name": "networkofferingdisplaytext", "type": "string" } ] @@ -120962,23 +121333,23 @@ ], "related": "", "response": [ + {}, { - "description": "The path field for the volume", - "name": "path", + "description": "the UUID of the latest async 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 path field for the volume", + "name": "path", "type": "string" - }, - {} + } ] }, { @@ -120986,14 +121357,6 @@ "isasync": false, "name": "listManagementServers", "params": [ - { - "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, @@ -121005,7 +121368,7 @@ { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, @@ -121017,31 +121380,63 @@ "type": "string" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "List by keyword", + "description": "the id of the management server", "length": 255, - "name": "keyword", + "name": "id", + "related": "listManagementServers", "required": false, - "type": "string" + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" } ], "related": "", "response": [ - {}, + { + "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 version of the management server", + "name": "version", + "type": "string" + }, + { + "description": "the java distribution name running the management server process", + "name": "javadistribution", + "type": "string" + }, + { + "description": "the version of the java distribution running the management server process", + "name": "javaversion", + "type": "string" + }, { "description": "the last agents this Management Server is responsible for, before shutdown or preparing for maintenance", "name": "lastagents", "type": "list" }, { - "description": "the version of the java distribution running the management server process", - "name": "javaversion", + "description": "the name of the OS distribution running on the management server", + "name": "osdistribution", "type": "string" }, { @@ -121050,23 +121445,18 @@ "type": "date" }, { - "description": "the agents this Management Server is responsible for", - "name": "agents", - "type": "list" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the last time the host on which this Management Server runs was booted", + "name": "lastboottime", + "type": "date" }, { - "description": "the last time this Management Server was stopped", - "name": "lastserverstop", - "type": "date" + "description": "the name of the management server", + "name": "name", + "type": "string" }, { - "description": "the number of pending jobs in this Management Server", - "name": "pendingjobscount", + "description": "the number of host agents this Management Server is responsible for", + "name": "agentscount", "type": "long" }, { @@ -121075,34 +121465,36 @@ "type": "string" }, { - "description": "the ID of the management server", - "name": "id", + "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": "the state of the management server", - "name": "state", - "type": "state" + "description": "the agents this Management Server is responsible for", + "name": "agents", + "type": "list" }, { - "description": "the name of the management server", - "name": "name", + "description": "the ID of the management server", + "name": "id", "type": "string" }, + {}, { "description": "the running OS kernel version for this Management Server", "name": "kernelversion", "type": "string" }, { - "description": "the IP Address for this Management Server. This is deprecated, please use 'ipaddress' instead.", - "name": "serviceip", - "type": "string" + "description": "the last time this Management Server was stopped", + "name": "lastserverstop", + "type": "date" }, { "description": "the IP Address for this Management Server", @@ -121110,30 +121502,9 @@ "type": "string" }, { - "description": "the java distribution name running the management server process", - "name": "javadistribution", - "type": "string" - }, - { - "description": "the number of host agents this Management Server is responsible for", - "name": "agentscount", - "type": "long" - }, - {}, - { - "description": "the version of the management server", - "name": "version", - "type": "string" - }, - { - "description": "the 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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -121143,18 +121514,12 @@ "name": "listTungstenFabricPolicyRule", "params": [ { - "description": "the uuid of Tungsten-Fabric policy", - "length": 255, - "name": "policyuuid", - "required": true, - "type": "string" - }, - { - "description": "", + "description": "the ID of zone", "length": 255, - "name": "pagesize", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "integer" + "type": "uuid" }, { "description": "", @@ -121164,19 +121529,18 @@ "type": "integer" }, { - "description": "the uuid of Tungsten-Fabric rule", + "description": "the uuid of Tungsten-Fabric policy", "length": 255, - "name": "ruleuuid", - "required": false, + "name": "policyuuid", + "required": true, "type": "string" }, { - "description": "the ID of zone", + "description": "", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { "description": "List by keyword", @@ -121184,60 +121548,53 @@ "name": "keyword", "required": false, "type": "string" + }, + { + "description": "the uuid of Tungsten-Fabric rule", + "length": 255, + "name": "ruleuuid", + "required": false, + "type": "string" } ], "related": "addTungstenFabricPolicyRule", "response": [ { - "description": "Tungsten-Fabric policy source network", - "name": "srcnetwork", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "Tungsten-Fabric policy destination end port", - "name": "destendport", - "type": "int" + "description": "Tungsten-Fabric policy protocol", + "name": "protocol", + "type": "string" }, { "description": "Tungsten-Fabric policy source ip prefix length", "name": "srcipprefixlen", "type": "int" }, - { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" - }, - { - "description": "Tungsten-Fabric policy destination network", - "name": "destnetwork", - "type": "string" - }, - { - "description": "Tungsten-Fabric policy destination ip prefix length", - "name": "destipprefixlen", - "type": "int" - }, { "description": "Tungsten-Fabric policy source ip prefix", "name": "srcipprefix", "type": "string" }, + {}, { - "description": "Tungsten-Fabric policy destination ip prefix", - "name": "destipprefix", + "description": "Tungsten-Fabric policy name", + "name": "direction", "type": "string" }, { - "description": "Tungsten-Fabric rule uuid", - "name": "uuid", + "description": "Tungsten-Fabric policy source network", + "name": "srcnetwork", "type": "string" }, - {}, { - "description": "Tungsten-Fabric policy protocol", - "name": "protocol", - "type": "string" + "description": "Tungsten-Fabric policy destination start port", + "name": "deststartport", + "type": "int" }, { "description": "the current status of the latest async job acting on this object", @@ -121245,9 +121602,9 @@ "type": "integer" }, { - "description": "Tungsten-Fabric policy source end port", - "name": "srcendport", - "type": "int" + "description": "Tungsten-Fabric policy action", + "name": "action", + "type": "string" }, { "description": "Tungsten-Fabric provider zone name", @@ -121260,29 +121617,43 @@ "type": "string" }, { - "description": "Tungsten-Fabric policy destination start port", - "name": "deststartport", + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" + }, + { + "description": "Tungsten-Fabric policy source start port", + "name": "srcstartport", "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", + "description": "Tungsten-Fabric policy destination ip prefix length", + "name": "destipprefixlen", "type": "int" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Tungsten-Fabric policy destination end port", + "name": "destendport", + "type": "int" + }, + { + "description": "Tungsten-Fabric rule uuid", + "name": "uuid", "type": "string" }, { - "description": "Tungsten-Fabric policy action", - "name": "action", + "description": "Tungsten-Fabric policy source end port", + "name": "srcendport", + "type": "int" + }, + { + "description": "Tungsten-Fabric policy destination ip prefix", + "name": "destipprefix", "type": "string" } ] @@ -121293,22 +121664,27 @@ "name": "deleteTungstenFabricPolicy", "params": [ { - "description": "the ID of zone", + "description": "the Uuid of Tungsten-Fabric tag type", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "policyuuid", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "the Uuid of Tungsten-Fabric tag type", + "description": "the ID of zone", "length": 255, - "name": "policyuuid", + "name": "zoneid", + "related": "listZones", "required": true, - "type": "string" + "type": "uuid" } ], "response": [ + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, {}, { "description": "the UUID of the latest async job acting on this object", @@ -121316,20 +121692,15 @@ "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": "true if operation is executed successfully", - "name": "success", - "type": "boolean" } ] }, @@ -121356,68 +121727,68 @@ ], "related": "", "response": [ + {}, { "description": "the account owning the instance group", "name": "account", "type": "string" }, - {}, { "description": "the domain ID of the instance group", "name": "domainid", "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", "type": "string" }, { - "description": "the name of the instance group", - "name": "name", + "description": "path of the Domain the instance group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + { + "description": "the 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 domain name of the instance group", "name": "domain", "type": "string" }, { - "description": "path of the Domain the instance group belongs to", - "name": "domainpath", + "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 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 ID of the instance group", "name": "id", "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" - } + {} ] }, { @@ -121426,11 +121797,11 @@ "name": "listTemplateDirectDownloadCertificates", "params": [ { - "description": "if set to true: include the hosts where the certificate is uploaded to", + "description": "", "length": 255, - "name": "listhosts", + "name": "pagesize", "required": false, - "type": "boolean" + "type": "integer" }, { "description": "List by keyword", @@ -121440,11 +121811,12 @@ "type": "string" }, { - "description": "", + "description": "the zone where certificates are uploaded", "length": 255, - "name": "page", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "integer" + "type": "uuid" }, { "description": "list direct download certificate by ID", @@ -121455,17 +121827,16 @@ "type": "uuid" }, { - "description": "the zone where certificates are uploaded", + "description": "if set to true: include the hosts where the certificate is uploaded to", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "listhosts", "required": false, - "type": "uuid" + "type": "boolean" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" } @@ -121473,23 +121844,14 @@ "related": "", "response": [ { - "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 version", - "name": "version", + "description": "the direct download certificate serial num", + "name": "serialnum", "type": "string" }, + {}, { - "description": "the hypervisor of the hosts where the certificate is uploaded", - "name": "hypervisor", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -121498,9 +121860,9 @@ "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 subject", @@ -121508,37 +121870,46 @@ "type": "string" }, { - "description": "the direct download certificate issuer", - "name": "validity", + "description": "the direct download certificate version", + "name": "version", + "type": "string" + }, + { + "description": "the direct download certificate id", + "name": "id", "type": "string" }, + { + "description": "the hosts where the certificate is uploaded to", + "name": "hostsmap", + "type": "list" + }, { "description": "the zone id where the certificate is uploaded", "name": "zoneid", "type": "string" }, + {}, { - "description": "the direct download certificate alias", - "name": "alias", + "description": "the hypervisor of the hosts where the certificate is uploaded", + "name": "hypervisor", "type": "string" }, { - "description": "the direct download certificate id", - "name": "id", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the zone name where the certificate is uploaded", - "name": "zonename", + "description": "the direct download certificate issuer", + "name": "validity", "type": "string" }, { - "description": "the direct download certificate serial num", - "name": "serialnum", + "description": "the direct download certificate alias", + "name": "alias", "type": "string" - }, - {}, - {} + } ], "since": "4.17.0" }, @@ -121547,6 +121918,14 @@ "isasync": false, "name": "listUcsManagers", "params": [ + { + "description": "the ID of the ucs manager", + "length": 255, + "name": "id", + "related": "listUcsManagers", + "required": false, + "type": "uuid" + }, { "description": "", "length": 255, @@ -121568,14 +121947,6 @@ "required": false, "type": "integer" }, - { - "description": "the ID of the ucs manager", - "length": 255, - "name": "id", - "related": "listUcsManagers", - "required": false, - "type": "uuid" - }, { "description": "the zone id", "length": 255, @@ -121587,22 +121958,17 @@ ], "related": "", "response": [ - { - "description": "the url of ucs manager", - "name": "url", - "type": "string" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, { - "description": "the name of ucs manager", - "name": "name", + "description": "the url of ucs manager", + "name": "url", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -121613,6 +121979,11 @@ "name": "id", "type": "string" }, + { + "description": "the name of ucs manager", + "name": "name", + "type": "string" + }, { "description": "the zone ID of ucs manager", "name": "zoneid", @@ -121645,19 +122016,101 @@ ], "related": "listRouters,listInternalLoadBalancerVMs", "response": [ + {}, + {}, { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", + "description": "the public IP address for the router", + "name": "publicip", "type": "string" }, { - "description": "the name of the router", - "name": "name", + "description": "the public MAC address for the router", + "name": "publicmacaddress", "type": "string" }, { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "the domain associated with the router", + "name": "domain", + "type": "string" + }, + { + "description": "path of the Domain the router belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the Zone ID for the router", + "name": "zoneid", + "type": "string" + }, + { + "description": "the second IPv6 DNS for the router", + "name": "ip6dns2", + "type": "string" + }, + { + "description": "the gateway for the router", + "name": "gateway", + "type": "string" + }, + { + "description": "the guest IP address for the router", + "name": "guestipaddress", + "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": "the guest MAC address for the router", + "name": "guestmacaddress", + "type": "string" + }, + { + "description": "the Pod name for the router", + "name": "podname", + "type": "string" + }, + { + "description": "the template ID for the router", + "name": "templateid", + "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 host ID for the router", + "name": "hostid", + "type": "string" + }, + { + "description": "the id of the router", + "name": "id", + "type": "string" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { @@ -121666,13 +122119,28 @@ "type": "boolean" }, { - "description": "the link local MAC address for the router", - "name": "linklocalmacaddress", + "description": "the second DNS for the router", + "name": "dns2", "type": "string" }, { - "description": "the id of the router", - "name": "id", + "description": "the version of the code / software in the router", + "name": "softwareversion", + "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 name of VPC the router belongs to", + "name": "vpcname", "type": "string" }, { @@ -121685,14 +122153,14 @@ "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" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", @@ -121700,28 +122168,28 @@ "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the isolation uri of the nic", + "name": "isolationuri", "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 netmask of the nic", - "name": "netmask", + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" }, { @@ -121730,8 +122198,13 @@ "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 Secondary ipv4 addr of nic", + "name": "secondaryip", "type": "list" }, { @@ -121740,23 +122213,33 @@ "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 isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { @@ -121765,23 +122248,18 @@ "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 name of the corresponding network", + "name": "networkname", + "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { @@ -121789,104 +122267,100 @@ "name": "deviceid", "type": "string" }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, { "description": "name of the vpc to which the nic belongs", "name": "vpcname", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the type of the nic", + "name": "type", + "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" } ], "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", + "description": "the version of template", + "name": "version", "type": "string" }, { - "description": "CPU arch of the router", - "name": "arch", + "description": "the first IPv6 DNS for the router", + "name": "ip6dns1", "type": "string" }, { - "description": "VPC the router belongs to", - "name": "vpcid", + "description": "role of the domain router", + "name": "role", "type": "string" }, { - "description": "the Zone ID for the router", - "name": "zoneid", + "description": "the name of the corresponding guest network", + "name": "guestnetworkname", "type": "string" }, { - "description": "the Zone name for the router", - "name": "zonename", - "type": "string" + "description": "Last executed health check result for the router", + "name": "healthcheckresults", + "response": [ + { + "description": "the 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": "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": "detailed response generated on running health check", + "name": "details", + "type": "string" + }, + { + "description": "the date this VPC was created", + "name": "lastupdated", + "type": "date" + } + ], + "type": "list" }, { "description": "the first DNS for the router", @@ -121894,84 +122368,58 @@ "type": "string" }, { - "description": "the state of the router", - "name": "state", - "type": "state" - }, - { - "description": "the version of scripts", - "name": "scriptsversion", - "type": "string" - }, - { - "description": "the date and time the router was created", - "name": "created", - "type": "date" - }, - { - "description": "the public IP address for the router", - "name": "publicip", + "description": "the hostname for the router", + "name": "hostname", "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "the ID of the corresponding link local network", + "name": "linklocalnetworkid", "type": "string" }, { - "description": "the ID of the corresponding public network", - "name": "publicnetworkid", + "description": "the template name for the router", + "name": "templatename", "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", + "description": "the version of scripts", + "name": "scriptsversion", "type": "string" }, - {}, { - "description": "the state of redundant virtual router", - "name": "redundantstate", + "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 MAC address for the router", + "name": "linklocalmacaddress", "type": "string" }, { - "description": "the template name for the router", - "name": "templatename", + "description": "the control state of the host for the router", + "name": "hostcontrolstate", "type": "string" }, { - "description": "role of the domain router", - "name": "role", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "the name of the corresponding guest network", - "name": "guestnetworkname", + "description": "the state of redundant virtual router", + "name": "redundantstate", "type": "string" }, { - "description": "the second DNS for the router", - "name": "dns2", + "description": "the link local netmask for the router", + "name": "linklocalnetmask", "type": "string" }, { @@ -121980,140 +122428,68 @@ "type": "string" }, { - "description": "path of the Domain the router belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the ID of the corresponding guest network", - "name": "guestnetworkid", + "description": "the link local IP address for the router", + "name": "linklocalip", "type": "string" }, { - "description": "the domain associated with the router", - "name": "domain", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "the gateway for the router", - "name": "gateway", + "description": "the Zone name for the router", + "name": "zonename", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", - "type": "string" + "description": "the state of the router", + "name": "state", + "type": "state" }, { - "description": "the Pod name for the router", - "name": "podname", + "description": "the account associated with the router", + "name": "account", "type": "string" }, { - "description": "the link local IP address for the router", - "name": "linklocalip", + "description": "the Pod ID for the router", + "name": "podid", "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 second IPv6 DNS for the router", - "name": "ip6dns2", - "type": "string" + "description": "if this router is an redundant virtual router", + "name": "isredundantrouter", + "type": "boolean" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - { - "description": "the domain ID associated with the router", - "name": "domainid", - "type": "string" - }, - { - "description": "the host ID for the router", - "name": "hostid", - "type": "string" - }, - { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", - "type": "string" - }, - { - "description": "Last executed health check result for the router", - "name": "healthcheckresults", - "response": [ - { - "description": "the date this VPC was created", - "name": "lastupdated", - "type": "date" - }, - { - "description": "result of the health check", - "name": "success", - "type": "boolean" - }, - { - "description": "detailed response generated on running health check", - "name": "details", - "type": "string" - }, - { - "description": "the type of the health check - basic or advanced", - "name": "checktype", - "type": "string" - }, - { - "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": "the public MAC address for the router", - "name": "publicmacaddress", - "type": "string" - }, { "description": "true if the router template requires upgrader", "name": "requiresupgrade", "type": "boolean" }, { - "description": "the guest IP address for the router", - "name": "guestipaddress", - "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 name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "CPU arch of the router", + "name": "arch", "type": "string" } ] @@ -122124,12 +122500,12 @@ "name": "updateVolume", "params": [ { - "description": "The state of the volume", + "description": "the ID of the disk volume", "length": 255, - "name": "state", + "name": "id", + "related": "importVolume,createVolume,updateVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "required": false, - "since": "4.3", - "type": "string" + "type": "uuid" }, { "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", @@ -122140,142 +122516,163 @@ "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": "Destination storage pool UUID for the volume", "length": 255, - "name": "chaininfo", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", "required": false, - "since": "4.4", - "type": "string" + "since": "4.3", + "type": "uuid" }, { - "description": "new name of the volume", + "description": "The chain info of the volume", "length": 255, - "name": "name", + "name": "chaininfo", "required": false, - "since": "4.16", + "since": "4.4", "type": "string" }, { - "description": "Destination storage pool UUID for the volume", + "description": "Set delete protection for the volume. If true, The volume will be protected from deletion. Note: If the volume is managed by another service like autoscaling groups or CKS, delete protection will be ignored.", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", + "name": "deleteprotection", "required": false, - "since": "4.3", - "type": "uuid" + "since": "4.20.0", + "type": "boolean" }, { - "description": "the ID of the disk volume", + "description": "The path of the volume", "length": 255, - "name": "id", - "related": "createVolume,updateVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,importVolume", + "name": "path", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "an optional field, whether to the display the volume to the end user or not.", + "description": "new name of the volume", "length": 255, - "name": "displayvolume", + "name": "name", "required": false, - "type": "boolean" + "since": "4.16", + "type": "string" }, { - "description": "The path of the volume", + "description": "The state of the volume", "length": 255, - "name": "path", + "name": "state", "required": false, + "since": "4.3", "type": "string" } ], - "related": "createVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,importVolume", + "related": "importVolume,createVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "response": [ { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", + "type": "string" + }, + { + "description": "name of the primary storage hosting the disk volume", + "name": "storage", + "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": "name of the availability zone", + "name": "zonename", + "type": "string" }, { - "description": "name of the virtual machine", - "name": "vmname", + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, { - "description": "size of the disk volume", - "name": "size", - "type": "long" + "description": "details for the volume check result, they may vary for different hypervisors", + "name": "volumecheckresult", + "type": "map" }, { - "description": "the bytes allocated", - "name": "virtualsize", - "type": "long" + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", + "type": "string" }, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", - "type": "long" + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", + "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "shared or local storage", + "name": "storagetype", "type": "string" }, + {}, { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "display name of the virtual machine", + "name": "vmdisplayname", + "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": "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" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the state of the disk volume", - "name": "state", + "description": "id of the virtual machine", + "name": "virtualmachineid", "type": "string" }, { - "description": "the path of the volume", - "name": "path", - "type": "string" + "description": "min iops of the disk volume", + "name": "miniops", + "type": "long" }, { - "description": "details for the volume repair result, they may vary for different hypervisors", - "name": "volumerepairresult", - "type": "map" + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", + "description": "the bytes actually consumed on disk", + "name": "physicalsize", "type": "long" }, { - "description": "min iops of the disk volume", - "name": "miniops", - "type": "long" + "description": "pod id of the volume", + "name": "podid", + "type": "string" + }, + { + "description": "the project id of the vpn", + "name": "projectid", + "type": "string" + }, + { + "description": "the format of the disk encryption if applicable", + "name": "encryptformat", + "type": "string" }, { "description": "the boolean state of whether the volume is destroyed or not", @@ -122283,23 +122680,38 @@ "type": "boolean" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", + "description": "the date the disk volume was created", + "name": "created", + "type": "date" + }, + { + "description": "true if volume has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + { + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "type of the virtual machine", + "name": "vmtype", "type": "string" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "description": "ID of the disk volume", + "name": "id", + "type": "string" + }, + { + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, { @@ -122308,8 +122720,8 @@ "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { @@ -122318,93 +122730,114 @@ "type": "string" }, { - "description": "pod id of the volume", - "name": "podid", + "description": "path of the Domain the disk volume belongs to", + "name": "domainpath", "type": "string" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "state of the virtual machine", + "name": "vmstate", "type": "string" }, { - "description": "shared or local storage", - "name": "storagetype", + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "type": "long" + }, + { + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", + "description": "the chain info of the volume", + "name": "chaininfo", "type": "string" }, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", + "type": "boolean" + }, + { + "description": "size of the disk volume", + "name": "size", + "type": "long" + }, + { + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "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": "cluster id of the volume", + "name": "clusterid", "type": "string" }, { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", "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 domain associated with the disk volume", - "name": "domain", + "description": "the state of the disk volume", + "name": "state", "type": "string" }, { - "description": "the format of the disk encryption if applicable", - "name": "encryptformat", - "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 id of the vpn", - "name": "projectid", + "description": "details for the volume repair result, they may vary for different hypervisors", + "name": "volumerepairresult", + "type": "map" + }, + {}, + { + "description": "name of the virtual machine", + "name": "vmname", "type": "string" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", + "description": "the disk utilization", + "name": "utilization", "type": "string" }, { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", - "type": "long" + "description": "name of the disk volume", + "name": "name", + "type": "string" }, { - "description": "state of the virtual machine", - "name": "vmstate", + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" }, { - "description": "type of the virtual machine", - "name": "vmtype", + "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": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "type": "string" }, { @@ -122412,33 +122845,28 @@ "name": "tags", "response": [ { - "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": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -122447,8 +122875,8 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -122457,37 +122885,27 @@ "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": "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 display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", - "type": "string" - }, - { - "description": "the disk utilization", - "name": "utilization", - "type": "string" - }, - { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" - }, - { - "description": "the project name of the vpn", - "name": "project", - "type": "string" + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, { "description": "need quiesce vm or not when taking snapshot", @@ -122495,50 +122913,34 @@ "type": "boolean" }, { - "description": "path of the Domain the disk volume belongs to", - "name": "domainpath", + "description": "pod name of the volume", + "name": "podname", "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": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "the path of the volume", + "name": "path", "type": "string" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", "type": "long" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" - }, - { - "description": "ID of the disk volume", - "name": "id", - "type": "string" - }, - {}, - { - "description": "the bytes actually consumed on disk", - "name": "physicalsize", + "description": "the bytes allocated", + "name": "virtualsize", "type": "long" }, { - "description": "pod name of the volume", - "name": "podname", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { "description": "max iops of the disk volume", @@ -122546,80 +122948,54 @@ "type": "long" }, { - "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": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", - "type": "boolean" + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "type": "long" }, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", - "type": "string" + "description": "the read (IO) of disk on the vm", + "name": "diskioread", + "type": "long" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "true if volume has delete protection.", - "name": "deleteprotection", - "type": "boolean" - }, - { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "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": "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": "cluster id of the volume", - "name": "clusterid", - "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", + "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": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "name of the disk volume", - "name": "name", + "description": "name of the service offering for root disk", + "name": "serviceofferingname", "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" - }, - {}, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" } ] }, @@ -122635,13 +123011,6 @@ "required": false, "type": "integer" }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, { "description": "List by keyword", "length": 255, @@ -122656,55 +123025,67 @@ "related": "", "required": true, "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" } ], "related": "", "response": [ {}, { - "description": "uuid of the network provider", - "name": "id", + "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 destination physical network", - "name": "destinationphysicalnetworkid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "state of the network provider", - "name": "state", + "description": "The network name label of the physical device dedicated to this traffic on a VMware host", + "name": "vmwarenetworklabel", "type": "string" }, { - "description": "services for this provider", - "name": "servicelist", - "type": "list" + "description": "the trafficType to be added to the physical network", + "name": "traffictype", + "type": "string" }, { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" + "description": "The network name label of the physical device dedicated to this traffic on a HyperV host", + "name": "hypervnetworklabel", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "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 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": "id of the network provider", + "name": "id", "type": "string" }, + {}, { - "description": "the provider name", - "name": "name", + "description": "The network name label of the physical device dedicated to this traffic on a XenServer host", + "name": "xennetworklabel", "type": "string" } ], @@ -122716,25 +123097,25 @@ "name": "updateAccount", "params": [ { - "description": "Details for the account used to store specific parameters", + "description": "The UUID of the domain where the account exists", "length": 255, - "name": "accountdetails", + "name": "domainid", + "related": "listDomains,listDomains", "required": false, - "type": "map" + "type": "uuid" }, { - "description": "The UUID of the dynamic role to set for the account", + "description": "Network domain for the account's networks; empty string will update domainName with NULL value", "length": 255, - "name": "roleid", - "related": "createRole,listRoles,updateRole", + "name": "networkdomain", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "The UUID of the domain where the account exists", + "description": "Account UUID", "length": 255, - "name": "domainid", - "related": "listDomains,listDomains", + "name": "id", + "related": "disableAccount,enableAccount,updateAccount,listAccounts", "required": false, "type": "uuid" }, @@ -122746,51 +123127,51 @@ "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": "Details for the account used to store specific parameters", "length": 255, - "name": "apikeyaccess", + "name": "accountdetails", "required": false, - "since": "4.20.1.0", - "type": "string" + "type": "map" }, { - "description": "New name for the account", + "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": "newname", + "name": "apikeyaccess", "required": false, + "since": "4.20.1.0", "type": "string" }, { - "description": "Network domain for the account's networks; empty string will update domainName with NULL value", + "description": "The UUID of the dynamic role to set for the account", "length": 255, - "name": "networkdomain", + "name": "roleid", + "related": "createRole,listRoles,updateRole", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "Account UUID", + "description": "New name for the account", "length": 255, - "name": "id", - "related": "disableAccount,enableAccount,updateAccount,listAccounts", + "name": "newname", "required": false, - "type": "uuid" + "type": "string" } ], "related": "disableAccount,enableAccount,listAccounts", "response": [ { - "description": "the total number of buckets available to this account", - "name": "bucketavailable", - "type": "string" + "description": "the total number of snapshots stored by this account", + "name": "snapshottotal", + "type": "long" }, { - "description": "id of the Domain the account belongs to", - "name": "domainid", - "type": "string" + "description": "the total volume being used by this account", + "name": "volumetotal", + "type": "long" }, { - "description": "the total number of snapshots available for this account", - "name": "snapshotavailable", + "description": "the total number of vpcs the account can own", + "name": "vpclimit", "type": "string" }, { @@ -122799,23 +123180,38 @@ "type": "apikeyaccess" }, { - "description": "the total primary storage space (in GiB) the account can own", - "name": "primarystoragelimit", + "description": "the total number of vpcs available to be created for this account", + "name": "vpcavailable", "type": "string" }, { - "description": "the total primary storage space (in GiB) available to be used for this account", - "name": "primarystorageavailable", + "description": "the total number of virtual machines running for this account", + "name": "vmrunning", + "type": "integer" + }, + { + "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": "the total number of vpcs owned by account", - "name": "vpctotal", + "description": "the total number of buckets which can be stored by this account", + "name": "bucketlimit", + "type": "string" + }, + { + "description": "the total primary storage space (in GiB) owned by account", + "name": "primarystoragetotal", "type": "long" }, { - "description": "the total number of vpcs the account can own", - "name": "vpclimit", + "description": "the default zone of the account", + "name": "defaultzoneid", "type": "string" }, { @@ -122823,43 +123219,33 @@ "name": "user", "response": [ { - "description": "the user firstname", - "name": "firstname", + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { - "description": "the user ID", - "name": "id", + "description": "the account name of the user", + "name": "account", "type": "string" }, { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" - }, - { - "description": "true if user has two factor authentication enabled", - "name": "is2faenabled", - "type": "boolean" - }, - { - "description": "true if user has two factor authentication is mandated", - "name": "is2famandated", - "type": "boolean" + "description": "the user name", + "name": "username", + "type": "string" }, { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the domain name of the user", + "name": "domain", + "type": "string" }, { - "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", - "name": "apikeyaccess", - "type": "apikeyaccess" + "description": "the timezone user was created in", + "name": "timezone", + "type": "string" }, { - "description": "the type of the role", - "name": "roletype", + "description": "the name of the role", + "name": "rolename", "type": "string" }, { @@ -122868,187 +123254,197 @@ "type": "resourceiconresponse" }, { - "description": "the domain ID of the user", - "name": "domainid", + "description": "the user state", + "name": "state", "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "the user email address", + "name": "email", "type": "string" }, { - "description": "the user email address", - "name": "email", + "description": "the type of the role", + "name": "roletype", "type": "string" }, { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" + "description": "the user ID", + "name": "id", + "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": "true if user has two factor authentication is mandated", + "name": "is2famandated", + "type": "boolean" + }, { "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 user lastname", + "name": "lastname", + "type": "string" }, { - "description": "the domain name of the user", - "name": "domain", - "type": "string" + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" }, { - "description": "the user state", - "name": "state", + "description": "the api key of the user", + "name": "apikey", "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 secret key of the user", + "name": "secretkey", "type": "string" }, { - "description": "the user lastname", - "name": "lastname", - "type": "string" + "description": "the date and time the user account was created", + "name": "created", + "type": "date" }, { - "description": "the timezone user was created in", - "name": "timezone", - "type": "string" + "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 boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", + "type": "boolean" }, { - "description": "the api key of the user", - "name": "apikey", + "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 source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", + "description": "the domain ID of the user", + "name": "domainid", "type": "string" } ], "type": "list" }, - {}, { - "description": "the total memory (in MB) the account can own", - "name": "memorylimit", + "description": "the total volume which can be used by this account", + "name": "volumelimit", "type": "string" }, { - "description": "the total number of gpus the account can own", - "name": "gpulimit", - "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": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "path of the Domain the account belongs to", - "name": "domainpath", - "type": "string" + "description": "the total secondary storage space (in GiB) owned by account", + "name": "secondarystoragetotal", + "type": "float" }, { - "description": "the total number of public ip addresses available for this account to acquire", - "name": "ipavailable", + "description": "the total object storage space (in GiB) available to the account", + "name": "objectstorageavailable", "type": "string" }, { - "description": "the total secondary storage space (in GiB) available to be used for this account", - "name": "secondarystorageavailable", + "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", + "description": "the total number of gpus the account can own", + "name": "gpulimit", "type": "string" }, { - "description": "the total volume being used by this account", - "name": "volumetotal", - "type": "long" + "description": "the total number of buckets available to this account", + "name": "bucketavailable", + "type": "string" }, { - "description": "the total number of public ip addresses this account can acquire", - "name": "iplimit", + "description": "the total number of virtual machines available for this account to acquire", + "name": "vmavailable", "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 primary storage space (in GiB) available to be used for this account", + "name": "primarystorageavailable", + "type": "string" }, { - "description": "the total object storage space (in GiB) the account can own", - "name": "objectstoragelimit", + "description": "the total secondary storage space (in GiB) the account can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "the total number of gpus available to be created for this account", - "name": "gpuavailable", + "description": "the total memory (in MB) the account can own", + "name": "memorylimit", "type": "string" }, { - "description": "the total number of virtual machines available for this account to acquire", - "name": "vmavailable", - "type": "string" + "description": "the total number of backups stored by this account", + "name": "backuptotal", + "type": "long" }, { - "description": "the total number of backups which can be stored by this account", - "name": "backuplimit", + "description": "the total number of backups available to this account", + "name": "backupavailable", "type": "string" }, { - "description": "the total number of virtual machines deployed by this account", - "name": "vmtotal", - "type": "long" + "description": "the total secondary storage space (in GiB) available to be used for this account", + "name": "secondarystorageavailable", + "type": "string" }, { - "description": "true if the account requires cleanup", - "name": "iscleanuprequired", - "type": "boolean" + "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": "the total number of public ip addresses this account can acquire", + "name": "iplimit", + "type": "string" }, { - "description": "the total number of templates available to be created by this account", - "name": "templateavailable", + "description": "the total number of 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 total number of projects available for administration by this account", + "name": "projectavailable", "type": "string" }, { @@ -123057,84 +123453,79 @@ "type": "integer" }, { - "description": "the default zone of the account", - "name": "defaultzoneid", - "type": "string" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "the total number of cpu cores owned by account", - "name": "cputotal", + "description": "the total backup storage space (in GiB) owned by the account", + "name": "backupstoragetotal", "type": "long" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "id of the Domain the account belongs to", + "name": "domainid", "type": "string" }, { - "description": "the total number of backups stored by this account", - "name": "backuptotal", - "type": "long" + "description": "the total number of virtual machines that can be deployed by this account", + "name": "vmlimit", + "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the network domain", + "name": "networkdomain", + "type": "string" }, { - "description": "the total number of vpcs available to be created for this account", - "name": "vpcavailable", + "description": "path of the Domain the account belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the total secondary storage space (in GiB) the account can own", - "name": "secondarystoragelimit", - "type": "string" + "description": "true if the account requires cleanup", + "name": "iscleanuprequired", + "type": "boolean" }, { - "description": "the total number of networks the account can own", - "name": "networklimit", + "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", + "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 number of virtual machines that can be deployed by this account", - "name": "vmlimit", + "description": "the id of the account", + "name": "id", "type": "string" }, { - "description": "the id of the account", - "name": "id", + "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 total number of gpus owned by account", + "name": "gputotal", + "type": "long" }, { - "description": "the total volume available for this account", - "name": "volumeavailable", - "type": "string" + "description": "the date when this account was created", + "name": "created", + "type": "date" }, { - "description": "the total number of projects the account can own", - "name": "projectlimit", + "description": "the total number of networks the account can own", + "name": "networklimit", "type": "string" }, { - "description": "the total number of projects available for administration by this account", - "name": "projectavailable", - "type": "string" + "description": "the list of acl groups that account belongs to", + "name": "groups", + "type": "list" }, { "description": "The tagged resource limit and count for the account", @@ -123142,33 +123533,33 @@ "type": "list" }, { - "description": "the total number of cpu cores available to be created for this account", - "name": "cpuavailable", + "description": "name of the Domain the account belongs to", + "name": "domain", "type": "string" }, { - "description": "the total secondary storage space (in GiB) owned by account", - "name": "secondarystoragetotal", - "type": "float" + "description": "the ID of the role", + "name": "roleid", + "type": "string" }, { - "description": "the total memory (in MB) owned by account", - "name": "memorytotal", - "type": "long" + "description": "the total number of snapshots which can be stored by this account", + "name": "snapshotlimit", + "type": "string" }, { - "description": "true if account is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the total number of templates which have been created by this account", + "name": "templatetotal", + "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the name of the account", + "name": "name", + "type": "string" }, { - "description": "the total number of cpu cores the account can own", - "name": "cpulimit", + "description": "the total backup storage space (in GiB) available to the account", + "name": "backupstorageavailable", "type": "string" }, { @@ -123177,125 +123568,115 @@ "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 stopped for this account", - "name": "vmstopped", - "type": "integer" - }, - { - "description": "the total number of templates which can be created by this account", - "name": "templatelimit", + "description": "the total volume available for this account", + "name": "volumeavailable", "type": "string" }, + {}, { - "description": "the list of acl groups that account belongs to", - "name": "groups", - "type": "list" - }, - { - "description": "name of the Domain the account belongs to", - "name": "domain", + "description": "the total number of backups which can be stored by this account", + "name": "backuplimit", "type": "string" }, { - "description": "the total number of networks owned by account", - "name": "networktotal", + "description": "the total number of projects being administrated by this account", + "name": "projecttotal", "type": "long" }, { - "description": "the total backup storage space (in GiB) owned by the account", - "name": "backupstoragetotal", - "type": "long" + "description": "the total number of virtual machines stopped for this account", + "name": "vmstopped", + "type": "integer" }, { - "description": "the total backup storage space (in GiB) available to the account", - "name": "backupstorageavailable", + "description": "the total object storage space (in GiB) the account can own", + "name": "objectstoragelimit", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "the total object storage space (in GiB) owned by the account", + "name": "objectstoragetotal", "type": "long" }, { - "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", - "name": "roletype", - "type": "string" + "description": "the total number of buckets stored by this account", + "name": "buckettotal", + "type": "long" }, { - "description": "the total number of gpus owned by account", - "name": "gputotal", + "description": "the total number of vpcs owned by account", + "name": "vpctotal", "type": "long" }, { - "description": "the total number of projects being administrated by this account", - "name": "projecttotal", + "description": "the total number of networks owned by account", + "name": "networktotal", "type": "long" }, { - "description": "the total volume which can be used by this account", - "name": "volumelimit", + "description": "the total number of gpus available to be created for this account", + "name": "gpuavailable", "type": "string" }, { - "description": "the name of the role", - "name": "rolename", + "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", + "name": "roletype", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total number of templates available to be created by this account", + "name": "templateavailable", "type": "string" }, { - "description": "the total number of buckets which can be stored by this account", - "name": "bucketlimit", + "description": "the state of the account", + "name": "state", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", + "description": "the total number of public ip addresses allocated for this account", + "name": "iptotal", "type": "long" }, { - "description": "the total object storage space (in GiB) owned by the account", - "name": "objectstoragetotal", + "description": "the total number of virtual machines deployed by this account", + "name": "vmtotal", "type": "long" }, { - "description": "the total object storage space (in GiB) available to the account", - "name": "objectstorageavailable", + "description": "the total memory (in MB) owned by account", + "name": "memorytotal", + "type": "long" + }, + { + "description": "the total number of networks available to be created for this account", + "name": "networkavailable", "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by account", - "name": "primarystoragetotal", - "type": "long" + "description": "true if account is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "the state of the account", - "name": "state", - "type": "string" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "the name of the account", - "name": "name", + "description": "the total backup storage space (in GiB) the account can own", + "name": "backupstoragelimit", "type": "string" }, { - "description": "the total number of virtual machines running for this account", - "name": "vmrunning", - "type": "integer" + "description": "the total number of cpu cores the account can own", + "name": "cpulimit", + "type": "string" } ] }, @@ -123323,38 +123704,39 @@ "related": "listSwifts", "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 url of the image store", - "name": "url", - "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 UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, + {}, { - "description": "the Zone name of the image store", - "name": "zonename", + "description": "the provider name of the image store", + "name": "providername", "type": "string" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", - "type": "long" + "description": "the protocol of the image store", + "name": "protocol", + "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 total disk size of the host", - "name": "disksizetotal", + "description": "the host's currently used disk size", + "name": "disksizeused", "type": "long" }, { @@ -123368,31 +123750,30 @@ "type": "string" }, { - "description": "the protocol of the image store", - "name": "protocol", - "type": "string" + "description": "defines if store is read-only", + "name": "readonly", + "type": "boolean" }, + {}, { - "description": "the provider name of the image store", - "name": "providername", + "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 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 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", + "type": "string" } ] }, @@ -123402,28 +123783,36 @@ "name": "updateVirtualMachine", "params": [ { - "description": "Number of days to lease the instance from now onward. Use -1 to remove the existing lease", + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "leaseduration", + "name": "customid", "required": false, - "since": "4.21.0", - "type": "integer" + "since": "4.4", + "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", - "type": "map" + "type": "uuid" }, { - "description": "list of security group ids to be applied on the virtual machine.", + "description": "instance name of the user vm", "length": 255, - "name": "securitygroupids", - "related": "", + "name": "instancename", "required": false, - "type": "list" + "since": "4.4", + "type": "string" + }, + { + "description": "true if high-availability is enabled for the virtual machine, false otherwise", + "length": 255, + "name": "haenable", + "required": false, + "type": "boolean" }, { "description": "Details in key/value pairs. 'extraconfig' is not allowed to be passed in details.", @@ -123433,20 +123822,35 @@ "type": "map" }, { - "description": "the ID of the userdata", + "description": "an optional binary data that can be sent to the virtual machine upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST (via POST body), you can send up to 1MB of data after base64 encoding. You also need to change vm.userdata.max.length value", + "length": 1048576, + "name": "userdata", + "required": false, + "since": "4.16.0", + "type": "string" + }, + { + "description": "user generated name", "length": 255, - "name": "userdataid", - "related": "", + "name": "displayname", "required": false, - "since": "4.18", - "type": "uuid" + "type": "string" }, { - "description": "optional boolean field, which indicates if details should be cleaned up or not (if set to true, details removed for this resource, details field ignored; if false or not set, no action)", + "description": "Number of days to lease the instance from now onward. Use -1 to remove the existing lease", "length": 255, - "name": "cleanupdetails", + "name": "leaseduration", "required": false, - "type": "boolean" + "since": "4.21.0", + "type": "integer" + }, + { + "description": "list of security group ids to be applied on the virtual machine.", + "length": 255, + "name": "securitygroupids", + "related": "", + "required": false, + "type": "list" }, { "description": "group of the virtual machine", @@ -123456,12 +123860,12 @@ "type": "string" }, { - "description": "The ID of 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": "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": "securitygroupnames", + "related": "", + "required": false, + "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", @@ -123471,20 +123875,18 @@ "type": "map" }, { - "description": "the ID of the OS type that best represents this VM.", + "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": "ostypeid", - "related": "addGuestOs", + "name": "cleanupdetails", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "new host name of the vm. The VM has to be stopped/started for this update to take affect", + "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": "name", + "name": "isdynamicallyscalable", "required": false, - "since": "4.4", - "type": "string" + "type": "boolean" }, { "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.", @@ -123495,50 +123897,51 @@ "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", + "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.4", + "since": "4.12", "type": "string" }, { - "description": "an optional field, whether to the display the vm to the end user or not.", + "description": "new host name of the vm. The VM has to be stopped/started for this update to take affect", "length": 255, - "name": "displayvm", + "name": "name", "required": false, - "type": "boolean" + "since": "4.4", + "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": "used to specify the parameters values for the variables in userdata.", "length": 255, - "name": "securitygroupnames", - "related": "", + "name": "userdatadetails", "required": false, - "type": "list" + "since": "4.18", + "type": "map" }, { - "description": "user generated name", + "description": "an optional field, whether to the display the vm to the end user or not.", "length": 255, - "name": "displayname", + "name": "displayvm", "required": false, - "type": "string" + "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": "The ID of the virtual machine", + "length": 255, + "name": "id", + "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,createVMFromBackup,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "required": true, + "type": "uuid" }, { - "description": "an optional URL encoded string that can be passed to the virtual machine upon successful deployment", - "length": 5120, - "name": "extraconfig", + "description": "the ID of the OS type that best represents this VM.", + "length": 255, + "name": "ostypeid", + "related": "addGuestOs", "required": false, - "since": "4.12", - "type": "string" + "type": "uuid" }, { "description": "Lease expiry action, valid values are STOP and DESTROY", @@ -123547,208 +123950,234 @@ "required": false, "since": "4.21.0", "type": "string" - }, + } + ], + "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,createVMFromBackup,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "response": [ { - "description": "instance name of the user vm", - "length": 255, - "name": "instancename", - "required": false, - "since": "4.4", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "true if high-availability is enabled for the virtual machine, false otherwise", - "length": 255, - "name": "haenable", - "required": false, - "type": "boolean" + "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. 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, + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", "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": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", + "type": "string" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the video RAM size in MB", - "name": "videoram", + "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 password (if exists) of the virtual machine", - "name": "password", - "type": "string" + "description": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "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": "true if vm has delete protection.", - "name": "deleteprotection", - "type": "boolean" + "description": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "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 account associated with the virtual machine", - "name": "account", + "description": "the format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, + {}, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "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 target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "the video RAM size in MB", + "name": "videoram", + "type": "long" + }, + { + "description": "the project name of the vm", + "name": "project", "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": "true if the entity/resource has annotations", + "name": "hasannotations", + "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 project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name of the group", - "name": "project", - "type": "string" - }, - { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", + "description": "the list of resource tags associated with the rule", + "name": "tags", "response": [ { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" + "description": "tag key name", + "name": "key", + "type": "string" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" + "description": "id of the resource", + "name": "resourceid", + "type": "string" }, { - "description": "security group name", - "name": "securitygroupname", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "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", + "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 domain associated with the tag", + "name": "domain", + "type": "string" + } + ], + "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 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" }, { @@ -123756,38 +124185,43 @@ "name": "cidr", "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 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": "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 domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -123796,39 +124230,69 @@ "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": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the 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 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": "security group name", + "name": "securitygroupname", + "type": "string" } ], "type": "set" }, { - "description": "the domain ID of the security group", - "name": "domainid", + "description": "the account owning the security group", + "name": "account", "type": "string" }, { - "description": "the description of the security group", - "name": "description", + "description": "the project name of the group", + "name": "project", "type": "string" }, { @@ -123837,32 +124301,17 @@ "type": "string" }, { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", + "description": "the description of the security group", + "name": "description", + "type": "string" + }, + { + "description": "the 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", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { @@ -123870,11 +124319,6 @@ "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", @@ -123890,18 +124334,18 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the 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" }, { @@ -123915,145 +124359,103 @@ "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": "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 project id the tag belongs to", - "name": "projectid", + "description": "id of the resource", + "name": "resourceid", "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 list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" }, { - "description": "resource type", - "name": "resourcetype", - "type": "string" + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "account owning the security group rule", + "name": "account", "type": "string" } ], "type": "set" }, { - "description": "the name of the security group", - "name": "name", + "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", + "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" } ], "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", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", "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 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", @@ -124061,272 +124463,121 @@ "type": "date" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "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 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 hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "the list of nics associated with vm", - "name": "nic", + "description": "the list of resource tags associated", + "name": "tags", "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", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "tag value", + "name": "value", "type": "string" } ], "type": "set" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "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 gpu card to which service offering is linked", - "name": "gpucardid", + "description": "User VM type", + "name": "vmtype", "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", - "type": "string" + "description": "the maximum Y resolution", + "name": "maxresolutiony", + "type": "long" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { "description": "the type of the template for the virtual machine", @@ -124339,167 +124590,138 @@ "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": "VNF details", - "name": "vnfdetails", - "type": "map" - }, - { - "description": "the maximum Y resolution", - "name": "maxresolutiony", - "type": "long" - }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, - { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "Instance lease duration in days", - "name": "leaseduration", - "type": "integer" - }, - { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", + "description": "the memory used by the VM in KiB", + "name": "memorykbs", "type": "long" }, - { - "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": "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", + "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", - "type": "string" + "description": "the maximum X resolution", + "name": "maxresolutionx", + "type": "long" }, { - "description": "the list of resource tags associated", - "name": "tags", + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", "response": [ { - "description": "id of the resource", - "name": "resourceid", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the description of the affinity group", + "name": "description", "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 ID of the domain associated with the tag", - "name": "domainid", + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", - "type": "string" + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" }, { - "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", + "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 account associated with the tag", - "name": "account", + "description": "the project name of the affinity group", + "name": "project", "type": "string" } ], "type": "set" }, + { + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, { "description": "Instance lease expiry action", "name": "leaseexpiryaction", "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", + "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 host for the virtual machine", - "name": "hostname", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "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 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": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", + "type": "string" }, { "description": "the name of the ISO attached to the virtual machine", @@ -124507,58 +124729,98 @@ "type": "string" }, { - "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": "CPU arch of the VM", - "name": "arch", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", + "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": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", + "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 ID of the gpu card to which service offering is linked", + "name": "gpucardid", + "type": "string" }, { - "description": "the name of the vgpu profile to which service offering is linked", - "name": "vgpuprofilename", + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, + { + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "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": "OS name of the vm", - "name": "osdisplayname", + "description": "the name of the virtual machine", + "name": "name", + "type": "string" + }, + { + "description": "the account associated with the virtual machine", + "name": "account", + "type": "string" + }, + { + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", + "type": "string" + }, + { + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" + }, + { + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", + "type": "string" + }, + { + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { @@ -124567,110 +124829,230 @@ "type": "string" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, { - "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": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", + "type": "string" + }, + { + "description": "the project id of the vm", + "name": "projectid", + "type": "string" + }, + { + "description": "the list of nics associated with vm", + "name": "nic", "response": [ { - "description": "the name of the affinity group", - "name": "name", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "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": "the description of the affinity group", - "name": "description", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the ID of the affinity group", - "name": "id", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "the type of the affinity group", + "description": "the type of the nic", "name": "type", "type": "string" }, { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "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 netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "the 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": "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 account owning the affinity group", - "name": "account", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", + "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": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", "type": "list" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" } ], "type": "set" }, + { + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + }, { "description": "the date when this virtual machine was updated last time", "name": "lastupdated", "type": "date" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "OS type id of the vm", + "name": "ostypeid", "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": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "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" }, { @@ -124679,55 +125061,54 @@ "type": "string" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "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": "Instance lease duration in days", + "name": "leaseduration", + "type": "integer" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" + "description": "the count of GPUs on the virtual machine", + "name": "gpucount", + "type": "integer" }, { - "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 maximum number of display heads", + "name": "maxheads", + "type": "long" }, { - "description": "User VM type", - "name": "vmtype", + "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": "the ID of the availability zone for the virtual machine", + "name": "zoneid", + "type": "string" }, { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, - {}, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "description": "the VM's primary IP address", + "name": "ipaddress", + "type": "string" } ] }, @@ -124736,13 +125117,6 @@ "isasync": true, "name": "disableAccount", "params": [ - { - "description": "If true, only lock the account; else disable the account", - "length": 255, - "name": "lock", - "required": true, - "type": "boolean" - }, { "description": "Disables specified account.", "length": 255, @@ -124765,24 +125139,31 @@ "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": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the total number of cpu cores owned by account", - "name": "cputotal", - "type": "long" + "description": "the id of the account", + "name": "id", + "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by account", - "name": "primarystoragetotal", - "type": "long" + "description": "the total secondary storage space (in GiB) owned by account", + "name": "secondarystoragetotal", + "type": "float" }, { "description": "the current status of the latest async job acting on this object", @@ -124790,28 +125171,29 @@ "type": "integer" }, { - "description": "the total number of templates which can be created by this account", - "name": "templatelimit", + "description": "the total number of snapshots which can be stored by this account", + "name": "snapshotlimit", "type": "string" }, { - "description": "details for the account", - "name": "accountdetails", - "type": "map" + "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 public ip addresses available for this account to acquire", + "name": "ipavailable", "type": "string" }, + {}, { - "description": "the total number of backups available to this account", - "name": "backupavailable", - "type": "string" + "description": "the total primary storage space (in GiB) owned by account", + "name": "primarystoragetotal", + "type": "long" }, { - "description": "the total backup storage space (in GiB) owned by the account", - "name": "backupstoragetotal", + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", "type": "long" }, { @@ -124819,14 +125201,69 @@ "name": "backuplimit", "type": "string" }, + { + "description": "the total number of networks owned by account", + "name": "networktotal", + "type": "long" + }, + { + "description": "the ID of the role", + "name": "roleid", + "type": "string" + }, + { + "description": "the total secondary storage space (in GiB) the account can own", + "name": "secondarystoragelimit", + "type": "string" + }, + { + "description": "the total memory (in MB) owned by account", + "name": "memorytotal", + "type": "long" + }, + { + "description": "the total number of buckets available to this account", + "name": "bucketavailable", + "type": "string" + }, + { + "description": "the total number of virtual machines deployed by this account", + "name": "vmtotal", + "type": "long" + }, { "description": "the total backup storage space (in GiB) the account can own", "name": "backupstoragelimit", "type": "string" }, { - "description": "the total number of vpcs the account can own", - "name": "vpclimit", + "description": "the total number of snapshots available for this account", + "name": "snapshotavailable", + "type": "string" + }, + { + "description": "true if the account requires cleanup", + "name": "iscleanuprequired", + "type": "boolean" + }, + { + "description": "The tagged resource limit and count for the account", + "name": "taggedresources", + "type": "list" + }, + { + "description": "the total number of vpcs available to be created for this account", + "name": "vpcavailable", + "type": "string" + }, + { + "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", + "name": "apikeyaccess", + "type": "apikeyaccess" + }, + { + "description": "the total number of cpu cores the account can own", + "name": "cpulimit", "type": "string" }, { @@ -124835,26 +125272,115 @@ "type": "long" }, { - "description": "the total number of projects available for administration by this account", - "name": "projectavailable", + "description": "the total secondary storage space (in GiB) available to be used for this account", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "the total memory (in MB) owned by account", - "name": "memorytotal", + "description": "details for the account", + "name": "accountdetails", + "type": "map" + }, + { + "description": "the total number of networks available to be created for this account", + "name": "networkavailable", + "type": "string" + }, + { + "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", + "name": "roletype", + "type": "string" + }, + { + "description": "the list of acl groups that account belongs to", + "name": "groups", + "type": "list" + }, + { + "description": "the total number of cpu cores owned by account", + "name": "cputotal", + "type": "long" + }, + { + "description": "the total number of snapshots stored by this account", + "name": "snapshottotal", + "type": "long" + }, + { + "description": "the total number of public ip addresses allocated for this account", + "name": "iptotal", + "type": "long" + }, + { + "description": "the total number of templates which can be created by this account", + "name": "templatelimit", + "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", + "type": "long" + }, + { + "description": "the total primary storage space (in GiB) available to be used for this account", + "name": "primarystorageavailable", + "type": "string" + }, + { + "description": "the state of the account", + "name": "state", + "type": "string" + }, + { + "description": "the total object storage space (in GiB) available to the account", + "name": "objectstorageavailable", + "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 public ip addresses this account can acquire", + "name": "iplimit", + "type": "string" + }, + { + "description": "the total number of buckets stored by this account", + "name": "buckettotal", "type": "long" }, + { + "description": "the total number of networks the account can own", + "name": "networklimit", + "type": "string" + }, { "description": "the total number of gpus available to be created for this account", "name": "gpuavailable", "type": "string" }, { - "description": "the total number of backups stored by this account", - "name": "backuptotal", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "the total number of projects being administrated by this account", + "name": "projecttotal", "type": "long" }, - {}, { "description": "the total number of virtual machines running for this account", "name": "vmrunning", @@ -124865,44 +125391,29 @@ "name": "bucketlimit", "type": "string" }, - { - "description": "the total number of public ip addresses allocated for this account", - "name": "iptotal", - "type": "long" - }, { "description": "the list of users associated with account", "name": "user", "response": [ { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", - "type": "boolean" - }, - { - "description": "the account ID of the user", - "name": "accountid", + "description": "the user firstname", + "name": "firstname", "type": "string" }, { - "description": "the user email address", - "name": "email", + "description": "the domain ID of the user", + "name": "domainid", "type": "string" }, { - "description": "the user firstname", - "name": "firstname", + "description": "the user ID", + "name": "id", "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": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", + "name": "apikeyaccess", + "type": "apikeyaccess" }, { "description": "the type of the role", @@ -124910,34 +125421,39 @@ "type": "string" }, { - "description": "the user lastname", - "name": "lastname", + "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 date and time the user account was created", - "name": "created", - "type": "date" + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", + "type": "boolean" }, { - "description": "the user name", - "name": "username", + "description": "the domain name of the user", + "name": "domain", "type": "string" }, { - "description": "the domain ID of the user", - "name": "domainid", + "description": "the user email address", + "name": "email", "type": "string" }, { - "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", - "name": "apikeyaccess", - "type": "apikeyaccess" + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" }, { - "description": "true if user has two factor authentication is mandated", - "name": "is2famandated", - "type": "boolean" + "description": "the account ID of the user", + "name": "accountid", + "type": "string" }, { "description": "the timezone user was created in", @@ -124945,38 +125461,43 @@ "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the user name", + "name": "username", + "type": "string" }, { - "description": "the domain name of the user", - "name": "domain", + "description": "the user lastname", + "name": "lastname", "type": "string" }, + { + "description": "the date and time the user account was created", + "name": "created", + "type": "date" + }, { "description": "the source type of the user in lowercase, such as native, ldap, saml2", "name": "usersource", "type": "string" }, { - "description": "the user state", - "name": "state", - "type": "string" + "description": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the ID of the role", - "name": "roleid", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the api key of the user", - "name": "apikey", + "description": "the user state", + "name": "state", "type": "string" }, { - "description": "the name of the role", - "name": "rolename", + "description": "the secret key of the user", + "name": "secretkey", "type": "string" }, { @@ -124985,261 +125506,131 @@ "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 secret key of the user", - "name": "secretkey", + "description": "the api key of the user", + "name": "apikey", "type": "string" }, { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" + "description": "the name of the role", + "name": "rolename", + "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", + "description": "the default zone of the account", + "name": "defaultzoneid", "type": "string" }, { - "description": "true if the account requires cleanup", - "name": "iscleanuprequired", + "description": "true if account is default, false otherwise", + "name": "isdefault", "type": "boolean" }, { - "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", - "name": "apikeyaccess", - "type": "apikeyaccess" - }, - { - "description": "the 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 date when this account was created", + "name": "created", + "type": "date" }, { - "description": "the total primary storage space (in GiB) the account can own", - "name": "primarystoragelimit", + "description": "name of the Domain the account belongs to", + "name": "domain", "type": "string" }, { - "description": "the total number of networks available to be created for this account", - "name": "networkavailable", + "description": "the total number of vpcs the account can own", + "name": "vpclimit", "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", + "description": "the total number of gpus the account can own", + "name": "gpulimit", "type": "string" }, { - "description": "the total volume available for this account", - "name": "volumeavailable", + "description": "the total number of virtual machines available for this account to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "the total number of networks the account can own", - "name": "networklimit", + "description": "the name of the role", + "name": "rolename", "type": "string" }, { - "description": "the state of the account", - "name": "state", + "description": "the total volume which can be used by this account", + "name": "volumelimit", "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", + "description": "the total memory (in MB) the account can own", + "name": "memorylimit", "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", - "type": "string" - }, - { - "description": "the total memory (in MB) available to be created for this account", - "name": "memoryavailable", + "description": "path of the Domain the account belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the total number of snapshots stored by this account", - "name": "snapshottotal", + "description": "the total number of backups stored by this account", + "name": "backuptotal", "type": "long" }, - { - "description": "the total object storage space (in GiB) the account can own", - "name": "objectstoragelimit", - "type": "string" - }, - { - "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", - "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", + "description": "the total primary storage space (in GiB) the account can own", + "name": "primarystoragelimit", "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "the total memory (in MB) available to be created for this account", + "name": "memoryavailable", "type": "string" }, { - "description": "the total number of templates available to be created by this account", - "name": "templateavailable", + "description": "the total volume available for this account", + "name": "volumeavailable", "type": "string" }, { - "description": "the total object storage space (in GiB) owned by the account", - "name": "objectstoragetotal", - "type": "long" - }, - { - "description": "path of the Domain the account belongs to", - "name": "domainpath", + "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", + "description": "the total volume being used by this account", + "name": "volumetotal", "type": "long" }, { - "description": "the total number of cpu cores available to be created for this account", - "name": "cpuavailable", - "type": "string" - }, - { - "description": "the name of the role", - "name": "rolename", - "type": "string" - }, - { - "description": "the total backup storage space (in GiB) available to the account", - "name": "backupstorageavailable", - "type": "string" - }, - { - "description": "the date when this account was created", - "name": "created", - "type": "date" - }, - { - "description": "the total number of gpus the account can own", - "name": "gpulimit", - "type": "string" - }, - { - "description": "the total number of projects the account can own", - "name": "projectlimit", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { - "description": "the total number of buckets available to this account", - "name": "bucketavailable", + "description": "the name of the account", + "name": "name", "type": "string" }, { @@ -125248,44 +125639,34 @@ "type": "integer" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "description": "the total number of public ip addresses this account can acquire", - "name": "iplimit", + "description": "the total number of backups available to this account", + "name": "backupavailable", "type": "string" }, { - "description": "name of the Domain the account belongs to", - "name": "domain", - "type": "string" + "description": "the total number of vpcs owned by account", + "name": "vpctotal", + "type": "long" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "the total object storage space (in GiB) the account can own", + "name": "objectstoragelimit", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the total backup storage space (in GiB) available to the account", + "name": "backupstorageavailable", + "type": "string" }, {}, { - "description": "true if account is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the total secondary storage space (in GiB) owned by account", - "name": "secondarystoragetotal", - "type": "float" + "description": "the total backup storage space (in GiB) owned by the account", + "name": "backupstoragetotal", + "type": "long" }, { - "description": "the total number of virtual machines available for this account to acquire", - "name": "vmavailable", + "description": "the total number of projects the account can own", + "name": "projectlimit", "type": "string" } ] @@ -125296,314 +125677,308 @@ "name": "listDomains", "params": [ { - "description": "Tag for resource type to return usage", + "description": "List domain by domain name.", "length": 255, - "name": "tag", + "name": "name", "required": false, - "since": "4.20.0", "type": "string" }, { - "description": "List domain by domain ID.", + "description": "List domains by domain level.", "length": 255, - "name": "id", - "related": "listDomains,listDomains", + "name": "level", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "flag to display the resource icon for domains", + "description": "comma separated list of domain details requested, value can be a list of [ all, resource, min]", "length": 255, - "name": "showicon", + "name": "details", "required": false, - "type": "boolean" + "type": "list" }, { - "description": "List domains by domain level.", + "description": "flag to display the resource icon for domains", "length": 255, - "name": "level", + "name": "showicon", "required": false, - "type": "integer" + "type": "boolean" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "List by keyword", + "description": "List domain by domain ID.", "length": 255, - "name": "keyword", + "name": "id", + "related": "listDomains,listDomains", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "List domain by domain name.", + "description": "List by keyword", "length": 255, - "name": "name", + "name": "keyword", "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", "length": 255, - "name": "page", + "name": "listall", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "comma separated list of domain details requested, value can be a list of [ all, resource, min]", + "description": "Tag for resource type to return usage", "length": 255, - "name": "details", + "name": "tag", "required": false, - "type": "list" + "since": "4.20.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", + "description": "", "length": 255, - "name": "listall", + "name": "pagesize", "required": false, - "type": "boolean" + "type": "integer" } ], "related": "listDomains", "response": [ { - "description": "the total number of gpus the domain can own", - "name": "gpulimit", + "description": "the total secondary storage space (in GiB) the domain can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "the total number of public ip addresses allocated for this domain", - "name": "iptotal", - "type": "long" + "description": "the total number of backups which can be stored by this domain", + "name": "backuplimit", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the domain ID of the parent domain", - "name": "parentdomainid", + "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", - "type": "long" - }, - { - "description": "the total number of backups stored by this domain", - "name": "backuptotal", - "type": "long" + "description": "the total number of buckets available to this domain", + "name": "bucketavailable", + "type": "string" }, { - "description": "the total volume being used by this domain", - "name": "volumetotal", - "type": "long" + "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 number of templates which can be created by this domain", + "name": "templatelimit", "type": "string" }, { - "description": "the total number of public ip addresses this domain can acquire", - "name": "iplimit", + "description": "the domain ID of the parent domain", + "name": "parentdomainid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "whether the domain has one or more sub-domains", + "name": "haschild", + "type": "boolean" }, { - "description": "the total secondary storage space (in GiB) the domain can own", - "name": "secondarystoragelimit", + "description": "the total number of networks available to be created for this domain", + "name": "networkavailable", "type": "string" }, { - "description": "the total number of networks owned by domain", - "name": "networktotal", + "description": "the total number of gpus owned by domain", + "name": "gputotal", "type": "long" }, { - "description": "the total object storage space (in GiB) the domain can own", - "name": "objectstoragelimit", + "description": "the name of the domain", + "name": "name", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the total number of virtual machines deployed by this domain", + "name": "vmtotal", + "type": "long" }, { - "description": "the total number of virtual machines available for this domain to acquire", - "name": "vmavailable", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the total number of snapshots available for this domain", - "name": "snapshotavailable", - "type": "string" + "description": "the total secondary storage space (in GiB) owned by domain", + "name": "secondarystoragetotal", + "type": "float" }, { - "description": "the total number of backups which can be stored by this domain", - "name": "backuplimit", - "type": "string" + "description": "the total number of templates which have been created by this domain", + "name": "templatetotal", + "type": "long" }, { - "description": "the total number of cpu cores the domain can own", - "name": "cpulimit", + "description": "the path of the domain", + "name": "path", "type": "string" }, { - "description": "the total number of networks available to be created for this domain", - "name": "networkavailable", + "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 total primary storage space (in GiB) the domain can own", + "name": "primarystoragelimit", + "type": "string" }, { - "description": "The tagged resource limit and count for the domain", - "name": "taggedresources", - "type": "list" + "description": "the total object storage space (in GiB) the domain can own", + "name": "objectstoragelimit", + "type": "string" }, { - "description": "details for the domain", - "name": "domaindetails", - "type": "map" + "description": "the date when this domain was created", + "name": "created", + "type": "date" }, { - "description": "the total number of networks the domain can own", - "name": "networklimit", + "description": "the ID of the domain", + "name": "id", "type": "string" }, { - "description": "the total number of projects the domain can own", - "name": "projectlimit", + "description": "the total volume which can be used by this domain", + "name": "volumelimit", "type": "string" }, { - "description": "the level of the domain", - "name": "level", - "type": "integer" - }, - { - "description": "the total number of templates which have been created by this domain", - "name": "templatetotal", - "type": "long" - }, - { - "description": "the total number of snapshots which can be stored by this domain", - "name": "snapshotlimit", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the total number of projects being administrated by this domain", - "name": "projecttotal", + "description": "the total object storage space (in GiB) owned by the domain", + "name": "objectstoragetotal", "type": "long" }, { - "description": "the total number of buckets stored by this domain", - "name": "buckettotal", + "description": "the total number of snapshots stored by this domain", + "name": "snapshottotal", "type": "long" }, { - "description": "the total number of gpus available to be created for this domain", - "name": "gpuavailable", + "description": "the total backup storage space (in GiB) available to the domain", + "name": "backupstorageavailable", "type": "string" }, { - "description": "the total number of vpcs available to be created for this domain", - "name": "vpcavailable", + "description": "the domain name of the parent domain", + "name": "parentdomainname", "type": "string" }, { - "description": "the state of the domain", - "name": "state", + "description": "the total number of snapshots which can be stored by this domain", + "name": "snapshotlimit", "type": "string" }, { - "description": "the total object storage space (in GiB) owned by the domain", - "name": "objectstoragetotal", + "description": "the total number of buckets stored by this domain", + "name": "buckettotal", "type": "long" }, { - "description": "the domain name of the parent domain", - "name": "parentdomainname", - "type": "string" + "description": "The tagged resource limit and count for the domain", + "name": "taggedresources", + "type": "list" }, { - "description": "the name of the domain", - "name": "name", + "description": "the total secondary storage space (in GiB) available to be used for this domain", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "the total number of backups available to this domain", - "name": "backupavailable", + "description": "the total memory (in MB) the domain can own", + "name": "memorylimit", "type": "string" }, { - "description": "the total backup storage space (in GiB) the domain can own", - "name": "backupstoragelimit", - "type": "string" + "description": "the total number of vpcs owned by domain", + "name": "vpctotal", + "type": "long" }, { - "description": "the total secondary storage space (in GiB) owned by domain", - "name": "secondarystoragetotal", - "type": "float" + "description": "the total memory (in MB) owned by domain", + "name": "memorytotal", + "type": "long" }, - {}, { - "description": "the path of the domain", - "name": "path", + "description": "the total number of cpu cores the domain can own", + "name": "cpulimit", "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "the total number of networks the domain can own", + "name": "networklimit", "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 total number of projects available for administration by this domain", - "name": "projectavailable", - "type": "string" + "description": "the total volume being used by this domain", + "name": "volumetotal", + "type": "long" }, { - "description": "the total number of virtual machines that can be deployed by this domain", - "name": "vmlimit", + "description": "the total number of cpu cores available to be created for this domain", + "name": "cpuavailable", "type": "string" }, { - "description": "the total secondary storage space (in GiB) available to be used for this domain", - "name": "secondarystorageavailable", + "description": "the total number of projects the domain can own", + "name": "projectlimit", "type": "string" }, { - "description": "the total memory (in MB) the domain can own", - "name": "memorylimit", + "description": "the total number of snapshots available for this domain", + "name": "snapshotavailable", "type": "string" }, { - "description": "whether the domain has one or more sub-domains", - "name": "haschild", - "type": "boolean" + "description": "the level of the domain", + "name": "level", + "type": "integer" }, { - "description": "the total backup storage space (in GiB) available to the domain", - "name": "backupstorageavailable", + "description": "the total number of networks owned by domain", + "name": "networktotal", + "type": "long" + }, + { + "description": "the total primary storage space (in GiB) available to be used for this domain", + "name": "primarystorageavailable", + "type": "string" + }, + { + "description": "the total number of vpcs available to be created for this domain", + "name": "vpcavailable", "type": "string" }, { @@ -125612,79 +125987,90 @@ "type": "resourceiconresponse" }, { - "description": "the total number of gpus owned by domain", - "name": "gputotal", - "type": "long" + "description": "the state of the domain", + "name": "state", + "type": "string" }, { - "description": "the ID of the domain", - "name": "id", + "description": "the total number of public ip addresses this domain can acquire", + "name": "iplimit", "type": "string" }, { - "description": "the total number of templates which can be created by this domain", - "name": "templatelimit", + "description": "the total number of virtual machines available for this domain to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "the total volume available for this domain", - "name": "volumeavailable", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { - "description": "the total number of buckets which can be stored by this domain", - "name": "bucketlimit", - "type": "string" + "description": "the total primary storage space (in GiB) owned by domain", + "name": "primarystoragetotal", + "type": "long" }, { - "description": "the total number of buckets available to this domain", - "name": "bucketavailable", + "description": "the total backup storage space (in GiB) the domain can own", + "name": "backupstoragelimit", "type": "string" }, - {}, { - "description": "the total primary storage space (in GiB) the domain can own", - "name": "primarystoragelimit", + "description": "the total number of buckets which can be stored by this domain", + "name": "bucketlimit", "type": "string" }, { - "description": "the total memory (in MB) available to be created for this domain", - "name": "memoryavailable", + "description": "the total number of public ip addresses available for this domain to acquire", + "name": "ipavailable", "type": "string" }, { - "description": "the total number of cpu cores available to be created for this domain", - "name": "cpuavailable", + "description": "details for the domain", + "name": "domaindetails", + "type": "map" + }, + { + "description": "the total number of projects available for administration by this domain", + "name": "projectavailable", "type": "string" }, { - "description": "the total number of virtual machines deployed by this domain", - "name": "vmtotal", + "description": "the total number of cpu cores owned by domain", + "name": "cputotal", "type": "long" }, { - "description": "the total object storage space (in GiB) available to the domain", - "name": "objectstorageavailable", + "description": "the total number of gpus the domain can own", + "name": "gpulimit", "type": "string" }, + {}, { - "description": "the total volume which can be used by this domain", - "name": "volumelimit", + "description": "the total number of backups stored by this domain", + "name": "backuptotal", + "type": "long" + }, + { + "description": "the total number of virtual machines that can be deployed by this domain", + "name": "vmlimit", "type": "string" }, + {}, { - "description": "the total number of cpu cores owned by domain", - "name": "cputotal", - "type": "long" + "description": "the total volume available for this domain", + "name": "volumeavailable", + "type": "string" }, { - "description": "the date when this domain was created", - "name": "created", - "type": "date" + "description": "the total number of backups available to this domain", + "name": "backupavailable", + "type": "string" }, { - "description": "the total number of snapshots stored by this domain", - "name": "snapshottotal", + "description": "the total number of projects being administrated by this domain", + "name": "projecttotal", "type": "long" }, { @@ -125693,18 +126079,13 @@ "type": "long" }, { - "description": "the total primary storage space (in GiB) available to be used for this domain", - "name": "primarystorageavailable", - "type": "string" - }, - { - "description": "the total number of templates available to be created by this domain", - "name": "templateavailable", + "description": "the total number of vpcs the domain can own", + "name": "vpclimit", "type": "string" }, { - "description": "the total number of public ip addresses available for this domain to acquire", - "name": "ipavailable", + "description": "the total memory (in MB) available to be created for this domain", + "name": "memoryavailable", "type": "string" } ] @@ -125715,19 +126096,20 @@ "name": "resetUserDataForVirtualMachine", "params": [ { - "description": "an optional project for the virtual machine", + "description": "an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "projectid", - "related": "", + "name": "domainid", + "related": "listDomains", "required": false, "type": "uuid" }, { - "description": "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 project for the virtual machine", + "length": 255, + "name": "projectid", + "related": "", "required": false, - "type": "string" + "type": "uuid" }, { "description": "the ID of the userdata", @@ -125737,14 +126119,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, @@ -125753,11 +126127,11 @@ "type": "string" }, { - "description": "an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used.", + "description": "The ID of the virtual machine", "length": 255, - "name": "domainid", - "related": "listDomains", - "required": false, + "name": "id", + "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,createVMFromBackup,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "required": true, "type": "uuid" }, { @@ -125766,78 +126140,40 @@ "name": "userdatadetails", "required": false, "type": "map" - } - ], - "related": "deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm", - "response": [ - { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "the video RAM size in MB", - "name": "videoram", - "type": "long" - }, - { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" - }, - { - "description": "the group ID of the virtual machine", - "name": "groupid", - "type": "string" - }, - { - "description": "ssh key-pairs", - "name": "keypairs", - "type": "string" - }, - { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" - }, - { - "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": "an optional binary data that can be sent to the virtual machine upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST (via POST body), you can send up to 1MB of data after base64 encoding. You also need to change vm.userdata.max.length value", + "length": 1048576, + "name": "userdata", + "required": false, "type": "string" - }, + } + ], + "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,createVMFromBackup,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "response": [ { - "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": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" - }, - { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", "type": "string" }, { - "description": "the ID of the vgpu profile to which service offering is linked", - "name": "vgpuprofileid", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "the name of the gpu card to which service offering is linked", - "name": "gpucardname", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { @@ -125846,277 +126182,165 @@ "type": "date" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" - }, - { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "true if vm has delete protection.", - "name": "deleteprotection", + "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 total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the 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 ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, - {}, - { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" - }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", + "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", - "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", - "type": "string" + "description": "Instance lease duration in days", + "name": "leaseduration", + "type": "integer" }, { - "description": "the list of nics associated with vm", - "name": "nic", - "response": [ - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "type": "string" + }, + { + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", + "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 ISO attached to the virtual machine", + "name": "isoname", + "type": "string" + }, + { + "description": "the ID of the virtual machine", + "name": "id", + "type": "string" + }, + { + "description": "the user's name who deployed the virtual machine", + "name": "username", + "type": "string" + }, + { + "description": "Base64 string containing the user data", + "name": "userdata", + "type": "string" + }, + { + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", + "type": "string" + }, + { + "description": "User VM type", + "name": "vmtype", + "type": "string" + }, + { + "description": "the list of resource tags associated", + "name": "tags", + "response": [ { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the project name where tag belongs to", + "name": "project", "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 IPv6 address of network", - "name": "ip6address", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "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" } ], "type": "set" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" - }, - { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" - }, - { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" - }, - { - "description": "the ID of the virtual machine", - "name": "id", - "type": "string" - }, - { - "description": "Instance lease expiry action", - "name": "leaseexpiryaction", - "type": "string" - }, - {}, - { - "description": "the password (if exists) of the virtual machine", - "name": "password", - "type": "string" - }, - { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "the pool type of the virtual machine", + "name": "pooltype", "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", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { @@ -126124,9 +126348,14 @@ "name": "securitygroup", "response": [ { - "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 security group", + "name": "domain", + "type": "string" }, { "description": "the description of the security group", @@ -126137,19 +126366,24 @@ "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 starting IP of the security group rule", "name": "startport", "type": "integer" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "account owning the security group rule", + "name": "account", "type": "string" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { @@ -126158,42 +126392,47 @@ "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", + "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 list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "id of the resource", - "name": "resourceid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -126202,54 +126441,59 @@ "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": "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 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 domain associated with the tag", + "name": "domain", "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 ending IP of the security group rule ", - "name": "endport", - "type": "integer" } ], "type": "set" }, { - "description": "the ID of the security group", - "name": "id", + "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 project id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "path of the Domain the security group belongs to", + "name": "domainpath", "type": "string" }, { @@ -126257,47 +126501,52 @@ "name": "domainid", "type": "string" }, + { + "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 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 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": "the project name where tag belongs to", - "name": "project", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "tag value", - "name": "value", + "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": "id of the resource", - "name": "resourceid", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -126311,13 +126560,13 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -126329,13 +126578,13 @@ "type": "set" }, { - "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 code for the ICMP message response", - "name": "icmpcode", + "description": "the starting IP of the security group rule", + "name": "startport", "type": "integer" }, { @@ -126344,29 +126593,34 @@ "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 type of the ICMP message response", - "name": "icmptype", + "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": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { - "description": "security group name", - "name": "securitygroupname", + "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" @@ -126376,305 +126630,976 @@ "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" } ], "type": "set" }, { - "description": "the name of the security group", + "description": "the ID of the security group", + "name": "id", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the project id of the vm", + "name": "projectid", + "type": "string" + }, + { + "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 ID of the gpu card to which service offering is linked", + "name": "gpucardid", + "type": "string" + }, + { + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "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 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 affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ + { + "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": "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" }, { - "description": "the account owning the security group", - "name": "account", + "description": "the type of the affinity group", + "name": "type", "type": "string" }, { - "description": "the domain name of the security group", - "name": "domain", + "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 project ID of the affinity group", + "name": "projectid", + "type": "string" }, { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "the project name of the group", + "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 group", - "name": "projectid", + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + } + ], + "type": "set" + }, + { + "description": "the count of GPUs on the virtual machine", + "name": "gpucount", + "type": "integer" + }, + {}, + { + "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": "VNF details", + "name": "vnfdetails", + "type": "map" + }, + { + "description": "the name of the virtual machine", + "name": "name", + "type": "string" + }, + { + "description": "the video RAM size in MB", + "name": "videoram", + "type": "long" + }, + { + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" + }, + { + "description": "the name of the host for the virtual machine", + "name": "hostname", + "type": "string" + }, + { + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "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 user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" + }, + { + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" + }, + { + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", + "type": "string" + }, + { + "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": "ssh key-pairs", + "name": "keypairs", + "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 project name of the vm", + "name": "project", + "type": "string" + }, + { + "description": "State of the Service from LB rule", + "name": "servicestate", + "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": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", + "type": "string" + }, + { + "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": "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": "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 cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "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": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "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 ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "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": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", "type": "string" } ], "type": "set" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "type": "string" + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "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": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "the maximum Y resolution", + "name": "maxresolutiony", + "type": "long" + }, + { + "description": "Guest vm Boot Type", + "name": "boottype", + "type": "string" + }, + { + "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 name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", + "type": "string" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "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 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 template for the virtual machine", + "name": "templatename", + "type": "string" + }, + { + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" + }, + { + "description": "the password (if exists) of the virtual machine", + "name": "password", + "type": "string" + }, + { + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, + { + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", + "type": "string" + }, + { + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, + { + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", + "type": "string" + }, + {}, + { + "description": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" + }, + { + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" + }, + { + "description": "OS type id of the vm", + "name": "ostypeid", + "type": "string" + }, + { + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, + { + "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" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the name of userdata used for the VM", + "name": "userdataname", + "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 ID of the host for the virtual machine", + "name": "hostid", + "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 speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" + }, + { + "description": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" + }, + { + "description": "CPU arch of the VM", + "name": "arch", + "type": "string" + }, + {} + ], + "since": "4.18.0" + }, + { + "description": "Deletes a template from the system. All virtual machines using the deleted template will not be affected.", + "isasync": true, + "name": "deleteTemplate", + "params": [ + { + "description": "the ID of zone of the template", + "length": 255, + "name": "zoneid", + "related": "listZones", + "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": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,listIsos,createTemplate,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "required": true, + "type": "uuid" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" + "description": "Force delete a template.", + "length": 255, + "name": "forced", + "required": false, + "since": "4.9+", + "type": "boolean" + } + ], + "response": [ + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "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", - "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": "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": "path of the Domain the affinity group belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" - }, - { - "description": "the project ID of the affinity group", - "name": "projectid", - "type": "string" - } - ], - "type": "set" + "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", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {} + ] + }, + { + "description": "Lists all network ACLs", + "isasync": false, + "name": "listNetworkACLLists", + "params": [ { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "list network ACLs by specified name", + "length": 255, + "name": "name", + "required": false, + "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": "", + "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 speed of each vCPU", - "name": "cpuspeed", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources 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 network ACL with the specified ID.", + "length": 255, + "name": "id", + "related": "createNetworkACLList,listNetworkACLLists", + "required": false, + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, "type": "integer" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", - "type": "string" + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" }, { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" + "description": "list network ACLs by network ID", + "length": 255, + "name": "networkid", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork", + "required": false, + "type": "uuid" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", - "type": "string" + "description": "list 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 host for the virtual machine", - "name": "hostid", - "type": "string" + "description": "list network ACLs by VPC ID", + "length": 255, + "name": "vpcid", + "related": "listVPCs,createVPC,listVPCs,updateVPC", + "required": false, + "type": "uuid" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + } + ], + "related": "createNetworkACLList", + "response": [ + { + "description": "the ID of the ACL", + "name": "id", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "Description of the ACL", + "name": "description", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "the Name of the ACL", + "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 domain in which the virtual machine exists", - "name": "domainid", + "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": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "Name of the VPC this ACL is associated with", + "name": "vpcname", "type": "string" }, { - "description": "the state of the virtual machine", + "description": "is ACL for display to the regular user", + "name": "fordisplay", + "type": "boolean" + } + ] + }, + { + "description": "Archives (moves) a snapshot on primary storage to secondary storage", + "isasync": true, + "name": "archiveSnapshot", + "params": [ + { + "description": "The ID of the snapshot", + "length": 255, + "name": "id", + "related": "copySnapshot,archiveSnapshot,listSnapshots", + "required": true, + "type": "uuid" + } + ], + "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": "string" + "type": "state" }, { - "description": "the project name of the vm", - "name": "project", + "description": "name of the datastore for the snapshot entry", + "name": "datastorename", "type": "string" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "ID of the datastore for the snapshot entry", + "name": "datastoreid", "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": "physical size of backedup snapshot on image store", + "name": "physicalsize", + "type": "long" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "id of the os on volume", + "name": "ostypeid", + "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", + "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 maximum number of display heads", - "name": "maxheads", - "type": "long" + "description": "state of the disk volume", + "name": "volumestate", + "type": "string" }, { - "description": "the maximum Y resolution", - "name": "maxresolutiony", - "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", + "description": "the type of the snapshot", + "name": "snapshottype", "type": "string" }, + { + "description": "ID of the disk volume", + "name": "volumeid", + "type": "string" + }, + { + "description": "download progress of a snapshot", + "name": "downloaddetails", + "type": "map" + }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -126688,8 +127613,13 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -126707,6 +127637,11 @@ "name": "domain", "type": "string" }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, { "description": "the account associated with the tag", "name": "account", @@ -126716,357 +127651,519 @@ "description": "tag value", "name": "value", "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 id of userdata used for the VM", - "name": "userdataid", + "description": "virtual size of backedup snapshot on image store", + "name": "virtualsize", + "type": "long" + }, + { + "description": "valid location types are primary and secondary.", + "name": "locationtype", "type": "string" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" + "description": "name of the disk volume", + "name": "volumename", + "type": "string" }, { - "description": "Instance lease expiry date", - "name": "leaseexpirydate", + "description": " the date the snapshot was created", + "name": "created", "type": "date" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the domain ID of the snapshot's account", + "name": "domainid", "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "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": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "the domain name of the snapshot's account", + "name": "domain", "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "the project name of the snapshot", + "name": "project", "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": "type of the datastore for the snapshot entry", + "name": "datastoretype", + "type": "string" }, - {}, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "valid types are hourly, daily, weekly, monthy, template, and none.", + "name": "intervaltype", "type": "string" }, { - "description": "the account associated with the virtual machine", + "description": "the account associated with the snapshot", "name": "account", "type": "string" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "display name of the os on volume", + "name": "osdisplayname", "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" + "description": "indicates whether the underlying storage supports reverting the volume to this snapshot", + "name": "revertable", + "type": "boolean" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "ID of the snapshot", + "name": "id", "type": "string" }, { - "description": "CPU arch of the VM", - "name": "arch", + "description": "name of the snapshot", + "name": "name", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "path of the Domain the snapshot's account belongs to", + "name": "domainpath", "type": "string" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "id of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "the project id of the snapshot", + "name": "projectid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "state of the snapshot on the datastore", + "name": "datastorestate", + "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "type of the disk volume", + "name": "volumetype", "type": "string" }, { - "description": "the name of the vgpu profile to which service offering is linked", - "name": "vgpuprofilename", + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "the format of the template for the virtual machine", - "name": "templateformat", + "description": "the status of the template", + "name": "status", "type": "string" - }, + } + ] + }, + { + "description": "Updates site to site vpn local gateway", + "isasync": true, + "name": "updateVpnGateway", + "params": [ { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "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 pool type of the virtual machine", - "name": "pooltype", - "type": "string" + "description": "id of customer gateway", + "length": 255, + "name": "id", + "related": "updateVpnGateway", + "required": true, + "type": "uuid" }, { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", + "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": "", + "response": [ + { + "description": "the vpc name of this gateway", + "name": "vpcname", "type": "string" }, + {}, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "the public IP address", + "name": "publicip", + "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the domain name of the owner", + "name": "domain", "type": "string" }, { - "description": "the count of GPUs on the virtual machine", - "name": "gpucount", - "type": "integer" + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "the project id", + "name": "projectid", + "type": "string" }, { - "description": "the ID of the gpu card to which service offering is linked", - "name": "gpucardid", + "description": "the vpn gateway ID", + "name": "id", "type": "string" }, { - "description": "the maximum X resolution", - "name": "maxresolutionx", - "type": "long" + "description": "the vpc id of this gateway", + "name": "vpcid", + "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the domain path of the owner", + "name": "domainpath", "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "the domain id of the owner", + "name": "domainid", "type": "string" }, { - "description": "User VM type", - "name": "vmtype", + "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 owner", + "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": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "the project name", + "name": "project", "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", + "description": "is vpn gateway for display to the regular user", + "name": "fordisplay", "type": "boolean" + } + ], + "since": "4.4" + }, + { + "description": "Releases a dedicated guest vlan range to the system", + "isasync": true, + "name": "releaseDedicatedGuestVlanRange", + "params": [ + { + "description": "the ID of the dedicated guest vlan range", + "length": 255, + "name": "id", + "related": "", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, + {}, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, { - "description": "Instance lease duration in days", - "name": "leaseduration", + "description": "the UUID of the latest async 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": "Deletes a template from the system. All virtual machines using the deleted template will not be affected.", - "isasync": true, - "name": "deleteTemplate", + "description": "Deletes security group", + "isasync": false, + "name": "deleteSecurityGroup", "params": [ { - "description": "the ID of the template", + "description": "The ID of the security group. Mutually exclusive with id parameter", + "length": 255, + "name": "name", + "required": false, + "type": "string" + }, + { + "description": "The ID of the security group. Mutually exclusive with name parameter", "length": 255, "name": "id", - "related": "listIsos,createTemplate,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", - "required": true, + "related": "", + "required": false, "type": "uuid" }, { - "description": "the ID of zone of the template", + "description": "the project of the security group", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "projectid", + "related": "", "required": false, "type": "uuid" }, { - "description": "Necessary if the template's type is system.", + "description": "the domain ID of account owning the security group", "length": 255, - "name": "issystem", + "name": "domainid", + "related": "listDomains", "required": false, - "since": "4.20.0", - "type": "boolean" + "type": "uuid" }, { - "description": "Force delete a template.", + "description": "the account of the security group. Must be specified with domain ID", "length": 255, - "name": "forced", + "name": "account", "required": false, - "since": "4.9+", - "type": "boolean" + "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": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ] }, { - "description": "Lists all network ACLs", + "description": "Creates a customized GUI theme for a set of Common Names (fixed or wildcard), a set of domain UUIDs, and/or a set of account UUIDs.", "isasync": false, - "name": "listNetworkACLLists", + "name": "createGuiTheme", "params": [ { - "description": "Lists network ACL with the specified ID.", - "length": 255, - "name": "id", - "related": "createNetworkACLList,listNetworkACLLists", + "description": "A set of domain UUIDs (also known as ID for the end-user) separated by comma that can retrieve the theme.", + "length": 65535, + "name": "domainids", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", + "description": "The JSON with the configurations to be retrieved and imported into the GUI when matching the theme access configurations.", + "length": 65535, + "name": "jsonconfiguration", "required": false, "type": "string" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "A description for the theme.", + "length": 4096, + "name": "description", + "required": false, + "type": "string" + }, + { + "description": "A name to identify the theme.", + "length": 2048, + "name": "name", + "required": true, + "type": "string" + }, + { + "description": "The CSS to be retrieved and imported into the GUI when matching the theme access configurations.", + "length": 65535, + "name": "css", + "required": false, + "type": "string" + }, + { + "description": "A set of account UUIDs (also known as ID for the end-user) separated by comma that can retrieve the theme.", + "length": 65535, + "name": "accountids", + "required": false, + "type": "string" + }, + { + "description": "A set of Common Names (CN) (fixed or wildcard) separated by comma that can retrieve the theme; e.g.: *acme.com,acme2.com", + "length": 65535, + "name": "commonnames", + "required": false, + "type": "string" + }, + { + "description": "Defines whether 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": "isrecursive", + "name": "ispublic", "required": false, "type": "boolean" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "Defines whether the subdomains of the informed domains are considered. Default value is false.", "length": 255, - "name": "fordisplay", + "name": "recursivedomains", "required": false, - "since": "4.4", + "type": "boolean" + } + ], + "related": "", + "response": [ + {}, + { + "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": "list network ACLs by specified name", - "length": 255, + "description": "When the GUI theme was removed.", + "name": "removed", + "type": "date" + }, + { + "description": "Description of the GUI theme.", + "name": "description", + "type": "string" + }, + { + "description": "A set of 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": "ID of the custom GUI theme.", + "name": "id", + "type": "string" + }, + { + "description": "A set of domain UUIDs (also known as ID for the end-user) separated by comma that can retrieve the theme.", + "name": "domainids", + "type": "string" + }, + { + "description": "When the GUI theme was created.", + "name": "created", + "type": "date" + }, + { + "description": "Name of the GUI theme.", "name": "name", - "required": false, "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "The CSS to be retrieved and imported into the GUI when matching the theme access configurations.", + "name": "css", + "type": "string" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "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": "Whether to consider the subdomains of the informed domain IDs.", + "name": "recursivedomains", + "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" + }, + { + "description": "Import an unmanaged volume from a storage pool on a host into CloudStack", + "isasync": true, + "name": "importVolume", + "params": [ + { + "description": "the path of the volume", "length": 255, - "name": "projectid", - "related": "", - "required": false, - "type": "uuid" + "name": "path", + "required": true, + "type": "string" }, { - "description": "list network ACLs by network ID", + "description": "the ID of the disk offering linked to the volume", "length": 255, - "name": "networkid", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork", + "name": "diskofferingid", + "related": "", "required": false, "type": "uuid" }, { - "description": "list network ACLs by VPC ID", + "description": "the name of the volume. If not set, it will be set to the path of the volume.", "length": 255, - "name": "vpcid", - "related": "listVPCs,createVPC,listVPCs,updateVPC", + "name": "name", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list only resources belonging to the domain specified", + "description": "import volume to the domain specified", "length": 255, "name": "domainid", "related": "listDomains", @@ -127074,137 +128171,160 @@ "type": "uuid" }, { - "description": "List by keyword", + "description": "an optional account for the volume. Must be used with domainId.", "length": 255, - "name": "keyword", + "name": "account", "required": false, "type": "string" }, { - "description": "", + "description": "import volume for the project", "length": 255, - "name": "pagesize", + "name": "projectid", + "related": "", "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. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "the ID of the storage pool", "length": 255, - "name": "listall", - "required": false, - "type": "boolean" + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", + "required": true, + "type": "uuid" } ], - "related": "createNetworkACLList", + "related": "createVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "response": [ { - "description": "Id of the VPC this ACL is associated with", - "name": "vpcid", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the ID of the ACL", - "name": "id", + "description": "path of the Domain the disk volume belongs to", + "name": "domainpath", "type": "string" }, { - "description": "Description of the ACL", - "name": "description", - "type": "string" + "description": "details for the volume repair result, they may vary for different hypervisors", + "name": "volumerepairresult", + "type": "map" }, { - "description": "Name of the VPC this ACL is associated with", - "name": "vpcname", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" + }, + { + "description": "cluster id of the volume", + "name": "clusterid", "type": "string" }, { - "description": "is ACL for display to the regular user", - "name": "fordisplay", + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "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", + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", + "type": "long" + }, + { + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" + }, + { + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "the Name of the ACL", - "name": "name", + "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 current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - } - ] - }, - { - "description": "Archives (moves) a snapshot on primary storage to secondary storage", - "isasync": true, - "name": "archiveSnapshot", - "params": [ + }, { - "description": "The ID of the snapshot", - "length": 255, + "description": "ID of the disk volume", "name": "id", - "related": "copySnapshot,archiveSnapshot,listSnapshots", - "required": true, - "type": "uuid" - } - ], - "related": "copySnapshot,listSnapshots", - "response": [ + "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", + "type": "string" }, { - "description": "indicates whether the underlying storage supports reverting the volume to this snapshot", - "name": "revertable", - "type": "boolean" + "description": "name of the primary storage hosting the disk volume", + "name": "storage", + "type": "string" }, + {}, { - "description": "valid location types are primary and secondary.", - "name": "locationtype", + "description": "the bytes actually consumed on disk", + "name": "physicalsize", + "type": "long" + }, + { + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, { - "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 type of the snapshot", - "name": "snapshottype", + "description": "the format of the disk encryption if applicable", + "name": "encryptformat", "type": "string" }, { - "description": "the account associated with the snapshot", - "name": "account", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "physical size of backedup snapshot on image store", - "name": "physicalsize", + "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", + "description": "the path of the volume", + "name": "path", "type": "string" }, { - "description": "id of the availability zone", - "name": "zoneid", + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, { - "description": "ID of the datastore for the snapshot entry", - "name": "datastoreid", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { @@ -127212,8 +128332,13 @@ "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "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" }, { @@ -127222,18 +128347,18 @@ "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 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" }, { @@ -127242,13 +128367,8 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -127257,773 +128377,563 @@ "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": "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": "cluster name where the volume is allocated", + "name": "clustername", + "type": "string" + }, + { + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", "type": "string" }, { - "description": "ID of the snapshot", - "name": "id", + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, { - "description": "chain size of snapshot including all parent snapshots. Shown only for incremental snapshots if snapshot.show.chain.size setting is set to true", - "name": "chainsize", - "type": "long" + "description": "the state of the disk volume", + "name": "state", + "type": "string" }, { - "description": "download progress of a snapshot", - "name": "downloaddetails", - "type": "map" + "description": "state of the virtual machine", + "name": "vmstate", + "type": "string" }, - {}, { - "description": "name of the disk volume", - "name": "volumename", + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "the domain name of the snapshot's account", - "name": "domain", + "description": "shared or local storage", + "name": "storagetype", "type": "string" }, { - "description": "type of the disk volume", - "name": "volumetype", + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "display name of the os on volume", - "name": "osdisplayname", + "description": "the status of the volume", + "name": "status", "type": "string" }, { - "description": "the project name of the snapshot", - "name": "project", - "type": "string" + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", + "type": "long" }, { - "description": "virtual size of backedup snapshot on image store", + "description": "the bytes allocated", "name": "virtualsize", "type": "long" }, - {}, { - "description": "name of the snapshot", - "name": "name", + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "type": "string" }, { - "description": "name of the datastore for the snapshot entry", - "name": "datastorename", + "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 the snapshot's account belongs to", - "name": "domainpath", + "description": "name of the disk volume", + "name": "name", "type": "string" }, { - "description": "id of the os on volume", - "name": "ostypeid", + "description": "name of the virtual machine", + "name": "vmname", "type": "string" }, { - "description": "type of the datastore for the snapshot entry", - "name": "datastoretype", - "type": "string" + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", + "type": "boolean" }, { - "description": "ID of the disk volume", - "name": "volumeid", + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", "type": "string" }, + {}, { - "description": "valid types are hourly, daily, weekly, monthy, template, and none.", - "name": "intervaltype", - "type": "string" + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", + "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "name of the service offering for root disk", + "name": "serviceofferingname", + "type": "string" }, { - "description": "the project id of the snapshot", + "description": "the project id of the vpn", "name": "projectid", "type": "string" }, { - "description": "state of the disk volume", - "name": "volumestate", + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "type": "string" }, { - "description": "name of the availability zone", - "name": "zonename", - "type": "string" + "description": "max iops of the disk volume", + "name": "maxiops", + "type": "long" }, { - "description": "the domain ID of the snapshot's account", - "name": "domainid", + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, { - "description": " the date the snapshot was created", - "name": "created", - "type": "date" + "description": "the read (IO) of disk on the vm", + "name": "diskioread", + "type": "long" }, { - "description": "state of the snapshot on the datastore", - "name": "datastorestate", - "type": "string" - } - ] - }, - { - "description": "Updates site to site vpn local gateway", - "isasync": true, - "name": "updateVpnGateway", - "params": [ - { - "description": "id of customer gateway", - "length": 255, - "name": "id", - "related": "updateVpnGateway", - "required": true, - "type": "uuid" + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "type": "long" }, { - "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", + "description": "true if volume has delete protection.", + "name": "deleteprotection", "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": "", - "response": [ - { - "description": "the vpn gateway ID", - "name": "id", + "description": "type of the virtual machine", + "name": "vmtype", "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", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the owner", - "name": "account", + "description": "the UUID of the latest async 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": "pod id of the volume", + "name": "podid", + "type": "string" }, { - "description": "the public IP address", - "name": "publicip", - "type": "string" + "description": "min iops of the disk volume", + "name": "miniops", + "type": "long" }, { - "description": "the domain id of the owner", - "name": "domainid", + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" }, { - "description": "the domain path of the owner", - "name": "domainpath", - "type": "string" + "description": "the date the disk volume was created", + "name": "created", + "type": "date" }, { - "description": "the project name", - "name": "project", - "type": "string" + "description": "size of the disk volume", + "name": "size", + "type": "long" }, { - "description": "the project id", - "name": "projectid", + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the vpc id of this gateway", - "name": "vpcid", + "description": "display name of the virtual machine", + "name": "vmdisplayname", "type": "string" }, { - "description": "the domain name of the owner", + "description": "the domain associated with the disk volume", "name": "domain", "type": "string" - } - ], - "since": "4.4" - }, - { - "description": "Releases a dedicated guest vlan range to the system", - "isasync": true, - "name": "releaseDedicatedGuestVlanRange", - "params": [ - { - "description": "the ID of the dedicated guest vlan range", - "length": 255, - "name": "id", - "related": "", - "required": true, - "type": "uuid" - } - ], - "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" }, - {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "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 device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", + "name": "deviceid", + "type": "long" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", "type": "string" - } - ] - }, - { - "description": "Deletes security group", - "isasync": false, - "name": "deleteSecurityGroup", - "params": [ - { - "description": "the project of the security group", - "length": 255, - "name": "projectid", - "related": "", - "required": false, - "type": "uuid" }, { - "description": "the domain ID of account owning the security group", - "length": 255, - "name": "domainid", - "related": "listDomains", - "required": false, - "type": "uuid" + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", + "type": "boolean" }, { - "description": "the account of the security group. Must be specified with domain ID", - "length": 255, - "name": "account", - "required": false, + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "The ID of the security group. Mutually exclusive with name parameter", - "length": 255, - "name": "id", - "related": "", - "required": false, - "type": "uuid" - }, - { - "description": "The ID of the security group. Mutually exclusive with id parameter", - "length": 255, - "name": "name", - "required": false, - "type": "string" - } - ], - "response": [ - { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "id of the virtual machine", + "name": "virtualmachineid", "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": "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": "pod name of the volume", + "name": "podname", + "type": "string" } - ] + ], + "since": "4.19.1" }, { - "description": "Creates a customized GUI theme for a set of Common Names (fixed or wildcard), a set of domain UUIDs, and/or a set of account UUIDs.", - "isasync": false, - "name": "createGuiTheme", + "description": "Creates a template of a virtual machine. The virtual machine must be in a STOPPED state. A template created from this command is automatically designated as a private template visible to the account that created it.", + "isasync": true, + "name": "createTemplate", "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", - "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`.", + "description": "an optional accountName. Must be used with domainId.", "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", + "name": "account", "required": false, + "since": "4.19.0", "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", + "description": "Optional, only for baremetal hypervisor. The directory name where template stored on CIFS server", + "length": 2048, + "name": "url", "required": false, "type": "string" }, { - "description": "A set of Common Names (CN) (fixed or wildcard) separated by comma that can retrieve the theme; e.g.: *acme.com,acme2.com", - "length": 65535, - "name": "commonnames", + "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, - "type": "string" + "type": "uuid" }, { - "description": "The JSON with the configurations to be retrieved and imported into the GUI when matching the theme access configurations.", - "length": 65535, - "name": "jsonconfiguration", + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "length": 255, + "name": "isdynamicallyscalable", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "Defines whether the subdomains of the informed domains are considered. Default value is false.", + "description": "true if the template supports the sshkey upload feature; default is false", "length": 255, - "name": "recursivedomains", + "name": "sshkeyenabled", "required": false, "type": "boolean" }, { - "description": "A description for the theme.", - "length": 4096, - "name": "description", + "description": "true if the template supports the password reset feature; default is false", + "length": 255, + "name": "passwordenabled", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "A name to identify the theme.", - "length": 2048, + "description": "the name of the template", + "length": 255, "name": "name", "required": true, "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", - "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`.", + "description": "true if this template is a public template, false otherwise", + "length": 255, "name": "ispublic", + "required": false, "type": "boolean" }, { - "description": "When the GUI theme was removed.", - "name": "removed", - "type": "date" + "description": "create template for the project", + "length": 255, + "name": "projectid", + "related": "", + "required": false, + "type": "uuid" }, { - "description": "ID of the custom GUI theme.", - "name": "id", - "type": "string" + "description": "the zone for the template. Can be specified with snapshot only", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "since": "4.19.0", + "type": "uuid" }, { - "description": "Whether to consider the subdomains of the informed domain IDs.", - "name": "recursivedomains", + "description": "true if the template requires HVM, false otherwise", + "length": 255, + "name": "requireshvm", + "required": false, "type": "boolean" }, - {}, - { - "description": "A set of domain UUIDs (also known as ID for the end-user) separated by comma that can retrieve the theme.", - "name": "domainids", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "The CSS to be retrieved and imported into the GUI when matching the theme access configurations.", - "name": "css", - "type": "string" - }, { - "description": "Description of the GUI theme.", - "name": "description", - "type": "string" + "description": "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 JSON with the configurations to be retrieved and imported into the GUI when matching the theme access configurations.", - "name": "jsonconfiguration", + "description": "the tag for this template.", + "length": 255, + "name": "templatetag", + "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.", - "name": "accountids", + "description": "The display text of the template, defaults to the 'name'.", + "length": 4096, + "name": "displaytext", + "required": false, "type": "string" }, { - "description": "When the GUI theme was created.", - "name": "created", - "type": "date" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "32 or 64 bit", + "length": 255, + "name": "bits", + "required": false, "type": "integer" }, - {} - ], - "since": "4.21.0.0" - }, - { - "description": "Import an unmanaged volume from a storage pool on a host into CloudStack", - "isasync": true, - "name": "importVolume", - "params": [ { - "description": "the path of the volume", + "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": "path", - "required": true, - "type": "string" + "name": "volumeid", + "related": "createVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "required": false, + "type": "uuid" }, { - "description": "import volume for the project", + "description": "the CPU arch of the template. Valid options are: x86_64, aarch64. Defaults to x86_64", "length": 255, - "name": "projectid", - "related": "", + "name": "arch", "required": false, - "type": "uuid" + "since": "4.20.2", + "type": "string" }, { - "description": "the ID of the disk offering linked to the volume", + "description": "an optional domainId. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "diskofferingid", - "related": "", + "name": "domainid", + "related": "listDomains", "required": false, + "since": "4.19.0", "type": "uuid" }, { - "description": "the name of the volume. If not set, it will be set to the path of the volume.", + "description": "true if this template is a featured template, false otherwise", "length": 255, - "name": "name", + "name": "isfeatured", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "the ID of the storage pool", + "description": "the ID of the OS Type that best represents the OS of this template.", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", + "name": "ostypeid", + "related": "addGuestOs", "required": true, "type": "uuid" }, { - "description": "import volume to the domain specified", + "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": "domainid", - "related": "listDomains", + "name": "virtualmachineid", + "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,createVMFromBackup,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "required": false, "type": "uuid" - }, - { - "description": "an optional account for the volume. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, - "type": "string" } ], - "related": "createVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", "response": [ { - "description": "max iops of the disk volume", - "name": "maxiops", - "type": "long" - }, - { - "description": "min iops of the disk volume", - "name": "miniops", - "type": "long" - }, - { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", - "type": "long" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "path of the Domain the disk volume belongs to", - "name": "domainpath", + "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": "name of the disk offering", - "name": "diskofferingname", + "description": "the id of userdata linked to this template", + "name": "userdataid", "type": "string" }, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" - }, - { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "description": "the ID of the OS type for this template.", + "name": "ostypeid", "type": "string" }, { - "description": "name of the disk volume", - "name": "name", + "description": "the name of the OS type for this template.", + "name": "ostypename", "type": "string" }, + {}, + {}, { - "description": "name of the availability zone", - "name": "zonename", - "type": "string" + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", + "type": "boolean" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" + "description": "the size of the template", + "name": "size", + "type": "long" }, { - "description": "pod id of the volume", - "name": "podid", - "type": "string" + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" }, { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", + "description": "the name of the domain to which the template belongs", + "name": "domain", "type": "string" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", "type": "boolean" }, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", + "description": "the ID of the zone for this template", + "name": "zoneid", "type": "string" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", "type": "string" }, { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", - "type": "long" - }, - { - "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": "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": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", "type": "boolean" }, { - "description": "the chain info of the volume", - "name": "chaininfo", - "type": "string" - }, - { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" - }, - { - "description": "id of the virtual machine", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "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": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the template name", + "name": "name", "type": "string" }, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", + "description": "the project id of the template", + "name": "projectid", "type": "string" }, { - "description": "the bytes actually consumed on disk", - "name": "physicalsize", - "type": "long" - }, - { - "description": "details for the volume check result, they may vary for different hypervisors", - "name": "volumecheckresult", - "type": "map" - }, - { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", - "type": "string" + "description": "the format of the template.", + "name": "format", + "type": "imageformat" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the project name of the template", + "name": "project", "type": "string" }, - {}, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", + "description": "the template display text", + "name": "displaytext", "type": "string" }, { - "description": "name of the virtual machine", - "name": "vmname", - "type": "string" + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", + "type": "boolean" }, { - "description": "the disk utilization", - "name": "utilization", + "description": "The name of extension linked to this template", + "name": "extensionname", "type": "string" }, { - "description": "cluster id of the volume", - "name": "clusterid", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "details for the volume repair result, they may vary for different hypervisors", - "name": "volumerepairresult", - "type": "map" - }, - { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", - "type": "string" + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "the ID of the secondary storage host for the template", + "name": "hostid", "type": "string" }, { - "description": "pod name of the volume", - "name": "podname", - "type": "string" + "description": "the date this template was created", + "name": "created", + "type": "date" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", - "type": "long" + "description": "If true it indicates that the template can be used for CKS cluster deployments", + "name": "forcks", + "type": "boolean" }, { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "the account id to which the template belongs", + "name": "accountid", "type": "string" }, { @@ -128036,8 +128946,13 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "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" }, { @@ -128046,8 +128961,8 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -128056,628 +128971,808 @@ "type": "string" }, { - "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": "the project name where tag belongs to", - "name": "project", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the 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": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "tag value", + "name": "value", "type": "string" } ], "type": "set" }, - {}, { - "description": "state of the virtual machine", - "name": "vmstate", + "description": "the name of userdata linked to this template", + "name": "userdataname", + "type": "string" + }, + { + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", + "type": "boolean" + }, + { + "description": "the URL which the template/iso is registered from", + "name": "url", + "type": "string" + }, + { + "description": "the template ID", + "name": "id", + "type": "string" + }, + { + "description": "the date this template was removed", + "name": "removed", + "type": "date" + }, + { + "description": "the tag of this template", + "name": "templatetag", "type": "string" }, + { + "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 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 type of the template", + "name": "templatetype", "type": "string" }, { - "description": "the account associated with the disk volume", - "name": "account", - "type": "string" + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "CPU Arch of the template", + "name": "arch", "type": "string" }, { - "description": "the bytes allocated", - "name": "virtualsize", - "type": "long" + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", + "type": "boolean" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "the name of the secondary storage host for the template", + "name": "hostname", "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": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "the name of the zone for this template", + "name": "zonename", "type": "string" }, { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", + "description": "checksum of the template", + "name": "checksum", + "type": "string" + }, + { + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", "type": "boolean" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", - "type": "string" + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" }, { - "description": "the project name of the vpn", - "name": "project", + "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 ID of the domain to which the template belongs", + "name": "domainid", "type": "string" }, { - "description": "shared or local storage", - "name": "storagetype", + "description": "the account name to which the template belongs", + "name": "account", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" + }, + { + "description": "the processor bit size", + "name": "bits", + "type": "int" + }, + { + "description": "the status of the template", + "name": "status", "type": "string" }, { - "description": "size of the disk volume", - "name": "size", - "type": "long" + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "ID of the disk volume", + "description": "path of the Domain the template belongs to", + "name": "domainpath", + "type": "string" + } + ] + }, + { + "description": "Restores an existing stopped or deleted VM using a VM backup", + "isasync": true, + "name": "restoreBackup", + "params": [ + { + "description": "ID of the backup", + "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 date the volume was attached to a VM instance", - "name": "attached", - "type": "date" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "the path of the volume", - "name": "path", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "the state of the disk volume", - "name": "state", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" + } + ], + "since": "4.14.0" + }, + { + "description": "Lists dedicated clusters.", + "isasync": false, + "name": "listDedicatedClusters", + "params": [ + { + "description": "the ID of the domain associated with the cluster", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" }, { - "description": "the format of the disk encryption if applicable", - "name": "encryptformat", + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "the name of the account associated with the cluster. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "list dedicated clusters by affinity group", + "length": 255, + "name": "affinitygroupid", + "related": "", + "required": false, + "type": "uuid" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", - "type": "long" + "description": "the ID of the cluster", + "length": 255, + "name": "clusterid", + "related": "addCluster,updateCluster", + "required": false, + "type": "uuid" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + } + ], + "related": "", + "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, + {}, { - "description": "true if volume has delete protection.", - "name": "deleteprotection", - "type": "boolean" + "description": "the name of the cluster", + "name": "clustername", + "type": "string" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": "the domain ID of the cluster", + "name": "domainid", "type": "string" }, + {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the ID of the cluster", + "name": "clusterid", + "type": "string" }, { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", - "type": "long" + "description": "the Account ID of the cluster", + "name": "accountid", + "type": "string" }, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "description": "the ID of the dedicated resource", + "name": "id", "type": "string" }, { - "description": "type of the virtual machine", - "name": "vmtype", + "description": "the Dedication Affinity Group ID of the cluster", + "name": "affinitygroupid", "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } - ], - "since": "4.19.1" + ] }, { - "description": "Creates a template of a virtual machine. The virtual machine must be in a STOPPED state. A template created from this command is automatically designated as a private template visible to the account that created it.", + "description": "Uploads a custom certificate for the console proxy VMs to use for SSL. Can be used to upload a single certificate signed by a known CA. Can also be used, through multiple calls, to upload a chain of certificates from CA to the custom certificate itself.", "isasync": true, - "name": "createTemplate", + "name": "uploadCustomCertificate", "params": [ { - "description": "the CPU arch of the template. Valid options are: x86_64, aarch64. Defaults to x86_64", + "description": "DNS domain suffix that the certificate is granted for.", "length": 255, - "name": "arch", - "required": false, - "since": "4.20.2", + "name": "domainsuffix", + "required": true, "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": "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": "snapshotid", - "related": "copySnapshot,listSnapshots", + "name": "id", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "an optional domainId. If the account parameter is used, domainId must also be used.", + "description": "A name / alias for the certificate.", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "name", "required": false, - "since": "4.19.0", - "type": "uuid" + "type": "string" }, { - "description": "32 or 64 bit", - "length": 255, - "name": "bits", + "description": "The private key for the attached certificate.", + "length": 65535, + "name": "privatekey", "required": false, - "type": "integer" + "type": "string" }, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "length": 255, - "name": "isdynamicallyscalable", - "required": false, - "type": "boolean" + "description": "The certificate to be uploaded.", + "length": 65535, + "name": "certificate", + "required": true, + "type": "string" + } + ], + "related": "", + "response": [ + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "Optional, only for baremetal hypervisor. The directory name where template stored on CIFS server", - "length": 2048, - "name": "url", - "required": false, + "description": "message of the certificate upload operation", + "name": "message", "type": "string" }, { - "description": "true if this template is a public template, false otherwise", - "length": 255, - "name": "ispublic", - "required": false, - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, + {} + ] + }, + { + "description": "Update quota calculations, alerts and statements", + "isasync": false, + "name": "quotaUpdate", + "params": [], + "related": "", + "response": [ + {}, + {}, { - "description": "an optional accountName. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, - "since": "4.19.0", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the zone for the template. Can be specified with snapshot only", + "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" + } + ], + "since": "4.7.0" + }, + { + "description": "list Tungsten-Fabric network", + "isasync": false, + "name": "listTungstenFabricNetwork", + "params": [ + { + "description": "the ID of zone", "length": 255, "name": "zoneid", "related": "listZones", "required": false, - "since": "4.19.0", "type": "uuid" }, { - "description": "true if the template requires HVM, false otherwise", + "description": "", "length": 255, - "name": "requireshvm", + "name": "page", "required": false, - "type": "boolean" + "type": "integer" }, { - "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", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that include public network. Default value is false", "length": 255, - "name": "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", + "name": "listall", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "true if the template supports the password reset feature; default is false", + "description": "the uuid of Tungsten-Fabric network", "length": 255, - "name": "passwordenabled", + "name": "networkuuid", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "the name of the template", + "description": "List by keyword", "length": 255, - "name": "name", - "required": true, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the tag for this template.", + "description": "", "length": 255, - "name": "templatetag", + "name": "pagesize", "required": false, + "type": "integer" + } + ], + "related": "", + "response": [ + { + "description": "Tungsten-Fabric network uuid", + "name": "uuid", "type": "string" }, + {}, { - "description": "true if this template is a featured template, false otherwise", - "length": 255, - "name": "isfeatured", - "required": false, - "type": "boolean" + "description": "Tungsten-Fabric network name", + "name": "name", + "type": "string" }, { - "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the ID of the OS Type that best represents the OS of this template.", - "length": 255, - "name": "ostypeid", - "related": "addGuestOs", - "required": true, - "type": "uuid" + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" }, { - "description": "the ID of the disk volume the template is being created from. Either this parameter, or snapshotId has to be passed in", + "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": "List traffic monitor Hosts.", + "isasync": false, + "name": "listTrafficMonitors", + "params": [ + { + "description": "zone Id", "length": 255, - "name": "volumeid", - "related": "createVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", - "required": false, + "name": "zoneid", + "related": "listZones", + "required": true, "type": "uuid" }, { - "description": "create template for the project", + "description": "", "length": 255, - "name": "projectid", - "related": "", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "The display text of the template, defaults to the 'name'.", - "length": 4096, - "name": "displaytext", + "description": "List by keyword", + "length": 255, + "name": "keyword", "required": false, "type": "string" }, { - "description": "true if the template supports the sshkey upload feature; default is false", + "description": "", "length": 255, - "name": "sshkeyenabled", + "name": "page", "required": false, - "type": "boolean" + "type": "integer" } ], - "related": "listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "related": "addTrafficMonitor", "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", + "description": "the zone ID of the external firewall", + "name": "zoneid", "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 timeout (in seconds) for requests to the external firewall", + "name": "timeout", + "type": "string" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "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 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": "the ID of the external firewall", + "name": "id", "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", + "description": "the management IP address of the external firewall", + "name": "ipaddress", "type": "string" }, { - "description": "the tag of this template", - "name": "templatetag", + "description": "the number of times to retry requests to the external firewall", + "name": "numretries", "type": "string" - }, + } + ] + }, + { + "description": "Releases an existing dedicated Bgp Peer.", + "isasync": true, + "name": "releaseBgpPeer", + "params": [ { - "description": "the name of the zone for this template", - "name": "zonename", - "type": "string" - }, + "description": "Id of the Bgp Peer", + "length": 255, + "name": "id", + "related": "releaseBgpPeer", + "required": true, + "type": "uuid" + } + ], + "related": "", + "response": [ { - "description": "the size of the template", - "name": "size", - "type": "long" + "description": "date when this bgp peer was created.", + "name": "created", + "type": "date" }, + {}, { - "description": "the type of the template", - "name": "templatetype", + "description": "the account of the bgp peer", + "name": "account", "type": "string" }, { - "description": "path of the Domain the template belongs to", - "name": "domainpath", - "type": "string" + "description": "additional key/value details of the bgp peer", + "name": "details", + "type": "map" }, { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", - "type": "boolean" + "description": "id of the bgp peer", + "name": "id", + "type": "string" }, { - "description": "the id of userdata linked to this template", - "name": "userdataid", + "description": "name of zone to which the bgp peer belongs to.", + "name": "zonename", "type": "string" }, { - "description": "the status of the template", - "name": "status", + "description": "the domain name of the bgp peer", + "name": "domain", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "id of zone to which the bgp peer belongs to.", + "name": "zoneid", "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 physical size of the template", - "name": "physicalsize", + "description": "AS number of bgp peer", + "name": "asnumber", "type": "long" }, { - "description": "the processor bit size", - "name": "bits", - "type": "int" - }, - { - "description": "the template display text", - "name": "displaytext", + "description": "IPv6 address of bgp peer", + "name": "ip6address", "type": "string" }, { - "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": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", + "description": "IPv4 address of bgp peer", + "name": "ipaddress", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the date this template was removed", - "name": "removed", - "type": "date" - }, - {}, - {}, - { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, - { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" + "description": "the domain ID of the bgp peer", + "name": "domainid", + "type": "string" }, { - "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", - "name": "userdataparams", + "description": "the project name of the bgp peer", + "name": "project", "type": "string" }, { - "description": "The name of extension linked to this template", - "name": "extensionname", + "description": "password of bgp peer", + "name": "password", "type": "string" }, { - "description": "the project id of the template", + "description": "the project id of the bgp peer", "name": "projectid", "type": "string" }, + {} + ], + "since": "4.20.0" + }, + { + "description": "Updates a port forwarding rule. Only the private port and the virtual machine can be updated.", + "isasync": true, + "name": "updatePortForwardingRule", + "params": [ { - "description": "the URL which the template/iso is registered from", - "name": "url", - "type": "string" + "description": "the ID of the virtual machine for the port forwarding rule", + "length": 255, + "name": "virtualmachineid", + "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,createVMFromBackup,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "required": false, + "type": "uuid" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the ID of the port forwarding rule", + "length": 255, + "name": "id", + "related": "updatePortForwardingRule", + "required": true, + "since": "4.4", + "type": "uuid" }, { - "description": "the name of the OS type for this template.", - "name": "ostypename", - "type": "string" + "description": "the private end port of the port forwarding rule", + "length": 255, + "name": "privateendport", + "required": false, + "type": "integer" }, { - "description": "CPU Arch of the template", - "name": "arch", - "type": "string" + "description": "the private start port of the port forwarding rule", + "length": 255, + "name": "privateport", + "required": false, + "type": "integer" }, { - "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", - "name": "deployasis", + "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 template name", - "name": "name", - "type": "string" + "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": "the account name to which the template belongs", - "name": "account", + "description": "VM guest nic Secondary ip address for the port forwarding rule", + "length": 255, + "name": "vmguestip", + "required": false, + "since": "4.5", "type": "string" }, { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", + "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 ID of the zone for this template", - "name": "zoneid", + "description": "the protocol of the port forwarding rule", + "name": "protocol", "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 guest network the port forwarding rule belongs to", + "name": "networkid", + "type": "string" }, { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", - "type": "boolean" + "description": "the VM display name for the port forwarding rule", + "name": "virtualmachinedisplayname", + "type": "string" }, { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", - "type": "boolean" + "description": "the starting port of port forwarding rule's private port range", + "name": "privateport", + "type": "string" }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", + "description": "the public ip address for the port forwarding rule", + "name": "ipaddress", "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the vm ip address for the port forwarding rule", + "name": "vmguestip", "type": "string" }, { - "description": "The ID of extension linked to this template", - "name": "extensionid", + "description": "the ending port of port forwarding rule's private port range", + "name": "publicendport", "type": "string" }, { - "description": "the template ID", - "name": "id", + "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": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the name of userdata linked to this template", - "name": "userdataname", + "description": "the starting port of port forwarding rule's public port range", + "name": "publicport", "type": "string" }, { - "description": "the name of the secondary storage host for the template", - "name": "hostname", + "description": "the ending port of port forwarding rule's private port range", + "name": "privateendport", "type": "string" }, { - "description": "the list of resource tags associated", + "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { @@ -128691,732 +129786,748 @@ "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 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" }, { - "description": "the domain associated with the tag", - "name": "domain", + "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": "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": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" } ], - "type": "set" + "type": "list" }, + {}, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "the VM name for the port forwarding rule", + "name": "virtualmachinename", + "type": "string" }, { - "description": "the date this template was created", - "name": "created", - "type": "date" + "description": "is firewall for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the project name of the template", - "name": "project", + "description": "the VM ID for the port forwarding rule", + "name": "virtualmachineid", "type": "string" }, { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", - "type": "boolean" + "description": "the public ip address id for the port forwarding rule", + "name": "ipaddressid", + "type": "string" }, { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" - } - ] - }, - { - "description": "Restores an existing stopped or deleted VM using a VM backup", - "isasync": true, - "name": "restoreBackup", - "params": [ - { - "description": "ID of the backup", - "length": 255, + "description": "the ID of the port forwarding rule", "name": "id", - "related": "", - "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", + "description": "the state of the rule", + "name": "state", "type": "string" - }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" } - ], - "since": "4.14.0" + ] }, { - "description": "Uploads a custom certificate for the console proxy VMs to use for SSL. Can be used to upload a single certificate signed by a known CA. Can also be used, through multiple calls, to upload a chain of certificates from CA to the custom certificate itself.", + "description": "Acquires and associates a public IP to an account.", "isasync": true, - "name": "uploadCustomCertificate", + "name": "associateIpAddress", "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", + "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": "id", + "name": "isportable", "required": false, - "type": "integer" - }, - { - "description": "The certificate to be uploaded.", - "length": 65535, - "name": "certificate", - "required": true, - "type": "string" + "type": "boolean" }, { - "description": "DNS domain suffix that the certificate is granted for.", + "description": "IP Address to be associated", "length": 255, - "name": "domainsuffix", - "required": true, - "type": "string" - }, - { - "description": "The private key for the attached certificate.", - "length": 65535, - "name": "privatekey", + "name": "ipaddress", "required": false, "type": "string" }, { - "description": "A name / alias for the certificate.", + "description": "the ID of the availability zone you want to acquire an public IP address from", "length": 255, - "name": "name", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "string" - } - ], - "related": "", - "response": [ - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "message of the certificate upload operation", - "name": "message", - "type": "string" + "type": "uuid" }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ] - }, - { - "description": "Lists dedicated clusters.", - "isasync": false, - "name": "listDedicatedClusters", - "params": [ { - "description": "the ID of the domain associated with the cluster", + "description": "the VPC you want the IP address to be associated with", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "vpcid", + "related": "listVPCs,createVPC,listVPCs,updateVPC", "required": false, "type": "uuid" }, { - "description": "the name of the account associated with the cluster. Must be used with domainId.", + "description": "an optional field, whether to the display the IP to the end user or not", "length": 255, - "name": "account", + "name": "fordisplay", "required": false, - "type": "string" + "since": "4.4", + "type": "boolean" }, { - "description": "", + "description": "the ID of the domain to associate with this IP address", "length": 255, - "name": "pagesize", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "List by keyword", + "description": "the account to associate with this IP address", "length": 255, - "name": "keyword", + "name": "account", "required": false, "type": "string" }, { - "description": "the ID of the cluster", + "description": "The network this IP address should be associated to.", "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", + "name": "networkid", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork", "required": false, "type": "uuid" }, { - "description": "", + "description": "region ID from where portable IP is to be associated.", "length": 255, - "name": "page", + "name": "regionid", + "related": "", "required": false, "type": "integer" }, { - "description": "list dedicated clusters by affinity group", + "description": "Deploy VM for the project", "length": 255, - "name": "affinitygroupid", + "name": "projectid", "related": "", "required": false, "type": "uuid" } ], - "related": "", + "related": "updateIpAddress,associateIpAddress,listPublicIpAddresses", "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "is public IP portable across the zones", + "name": "isportable", + "type": "boolean" + }, + { + "description": "date the public IP address was acquired", + "name": "allocated", + "type": "date" + }, + { + "description": "the ID of the VLAN associated with the IP address. This parameter is visible to ROOT admins only", + "name": "vlanid", + "type": "string" + }, {}, { - "description": "the ID of the dedicated resource", - "name": "id", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "the domain ID of the cluster", - "name": "domainid", + "description": "the name of the Network associated with the IP address", + "name": "associatednetworkname", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "path of the domain to which the public IP address belongs", + "name": "domainpath", "type": "string" }, { - "description": "the Account ID of the cluster", - "name": "accountid", + "description": "virtual machine type the ip address is assigned to", + "name": "virtualmachinetype", "type": "string" }, { - "description": "the ID of the cluster", - "name": "clusterid", + "description": "the ID of the Network associated with the IP address", + "name": "associatednetworkid", "type": "string" }, { - "description": "the name of the cluster", - "name": "clustername", + "description": "public IP address", + "name": "ipaddress", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the project name of the address", + "name": "project", + "type": "string" }, - {}, { - "description": "the Dedication Affinity Group ID of the cluster", - "name": "affinitygroupid", + "description": "virtual machine (dnat) ip address (not null only for static nat Ip)", + "name": "vmipaddress", "type": "string" - } - ] - }, - { - "description": "Update quota calculations, alerts and statements", - "isasync": false, - "name": "quotaUpdate", - "params": [], - "related": "", - "response": [ - {}, - {}, + }, + { + "description": "the ID of the zone the public IP address belongs to", + "name": "zoneid", + "type": "string" + }, + { + "description": "the account the public IP address is associated with", + "name": "account", + "type": "string" + }, + { + "description": "the name of the Network where ip belongs to", + "name": "networkname", + "type": "string" + }, + { + "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", + "type": "string" + }, + { + "description": "the ID of the Network where ip belongs to", + "name": "networkid", + "type": "string" + }, + { + "description": "true if range is dedicated for external network providers", + "name": "forprovider", + "type": "boolean" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, { - "description": "timestamp when the run got over", - "name": "updated_on", - "type": "date" + "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" - } - ], - "since": "4.7.0" - }, - { - "description": "list Tungsten-Fabric network", - "isasync": false, - "name": "listTungstenFabricNetwork", - "params": [ + "description": "public IP address id", + "name": "id", + "type": "string" + }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "true if this ip is system ip (was allocated as a part of deployVm or createLbRule)", + "name": "issystem", + "type": "boolean" + }, + { + "description": "virtual machine id the ip address is assigned to", + "name": "virtualmachineid", "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "VPC name the ip belongs to", + "name": "vpcname", + "type": "string" }, { - "description": "the ID of zone", - "length": 255, - "name": "zoneid", - "related": "listZones", - "required": false, - "type": "uuid" + "description": "the name of the zone the public IP address belongs to", + "name": "zonename", + "type": "string" }, { - "description": "the uuid of Tungsten-Fabric network", - "length": 255, - "name": "networkuuid", - "required": false, + "description": "true if the IP address is a source nat address, false otherwise", + "name": "issourcenat", + "type": "boolean" + }, + { + "description": "virtual machine name the ip address is assigned to", + "name": "virtualmachinename", "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "the list of resource tags associated with ip address", + "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 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 value", + "name": "value", + "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": "the account associated with the tag", + "name": "account", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the domain ID the public IP address is associated with", + "name": "domainid", + "type": "string" + }, + { + "description": "is public ip for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "true if this ip is for static nat, false otherwise", + "name": "isstaticnat", + "type": "boolean" + }, + { + "description": "true if range is dedicated for System VMs", + "name": "forsystemvms", + "type": "boolean" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that include public network. Default value is false", - "length": 255, - "name": "listall", - "required": false, + "description": "the virtual network for the IP address", + "name": "forvirtualnetwork", "type": "boolean" - } - ], - "related": "", - "response": [ - { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" }, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "the domain the public IP address is associated with", + "name": "domain", "type": "string" }, - {}, { - "description": "Tungsten-Fabric network uuid", - "name": "uuid", + "description": "the VLAN associated with the IP address", + "name": "vlanname", "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": "Tungsten-Fabric network name", - "name": "name", + "description": "virtual machine display name the ip address is assigned to (not null only for static nat Ip)", + "name": "virtualmachinedisplayname", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "whether the ip address has Firewall/PortForwarding/LoadBalancing rules defined", + "name": "hasrules", + "type": "boolean" } ] }, { - "description": "List traffic monitor Hosts.", + "description": "Get the SF Volume Access Group IDs", "isasync": false, - "name": "listTrafficMonitors", + "name": "getSolidFireVolumeAccessGroupIds", "params": [ { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "zone Id", + "description": "Storage Pool UUID", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "storageid", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "List by keyword", + "description": "Cluster UUID", "length": 255, - "name": "keyword", - "required": false, + "name": "clusterid", + "required": true, "type": "string" } ], - "related": "addTrafficMonitor", + "related": "", "response": [ { - "description": "the number of times to retry requests to the external firewall", - "name": "numretries", - "type": "string" - }, - { - "description": "the ID of the external firewall", - "name": "id", - "type": "string" - }, - { - "description": "the timeout (in seconds) for requests to the external firewall", - "name": "timeout", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "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 zone ID of the external firewall", - "name": "zoneid", - "type": "string" - }, - {}, - { - "description": "the management IP address of the external firewall", - "name": "ipaddress", - "type": "string" - } + {} ] }, { - "description": "Releases an existing dedicated Bgp Peer.", + "description": "Delete site to site vpn connection", "isasync": true, - "name": "releaseBgpPeer", + "name": "deleteVpnConnection", "params": [ { - "description": "Id of the Bgp Peer", + "description": "id of vpn connection", "length": 255, "name": "id", - "related": "releaseBgpPeer", + "related": "", "required": true, "type": "uuid" } ], - "related": "", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the account of the bgp peer", - "name": "account", - "type": "string" - }, - { - "description": "IPv4 address of bgp peer", - "name": "ipaddress", - "type": "string" - }, - { - "description": "IPv6 address of bgp peer", - "name": "ip6address", + "description": "any text associated with the success or failure", + "name": "displaytext", "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 UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "password of bgp peer", - "name": "password", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "id of zone to which the bgp peer belongs to.", - "name": "zoneid", - "type": "string" - }, + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ] + }, + { + "description": "Lists all alerts types", + "isasync": false, + "name": "listAlertTypes", + "params": [], + "related": "listAlerts", + "response": [ + {}, { - "description": "name of zone to which the bgp peer belongs to.", - "name": "zonename", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the domain ID of the bgp peer", - "name": "domainid", + "description": "the name of the alert", + "name": "name", "type": "string" }, - {}, { - "description": "additional key/value details of the bgp peer", - "name": "details", - "type": "map" + "description": "the date and time the alert was sent", + "name": "sent", + "type": "date" }, { - "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" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the id of the alert", + "name": "id", "type": "string" }, { - "description": "id of the bgp peer", - "name": "id", + "description": "description of the alert", + "name": "description", "type": "string" }, { - "description": "AS number of bgp peer", - "name": "asnumber", - "type": "long" + "description": "One of the following alert types: MEMORY = 0, CPU = 1, STORAGE = 2, STORAGE_ALLOCATED = 3, PUBLIC_IP = 4, PRIVATE_IP = 5, SECONDARY_STORAGE = 6, HOST = 7, USERVM = 8, DOMAIN_ROUTER = 9, CONSOLE_PROXY = 10, ROUTING = 11: lost connection to default route (to the gateway), STORAGE_MISC = 12, USAGE_SERVER = 13, MANAGMENT_NODE = 14, DOMAIN_ROUTER_MIGRATE = 15, CONSOLE_PROXY_MIGRATE = 16, USERVM_MIGRATE = 17, VLAN = 18, SSVM = 19, USAGE_SERVER_RESULT = 20, STORAGE_DELETE = 21, UPDATE_RESOURCE_COUNT = 22, USAGE_SANITY_RESULT = 23, DIRECT_ATTACHED_PUBLIC_IP = 24, LOCAL_STORAGE = 25, RESOURCE_LIMIT_EXCEEDED = 26, SYNC = 27, UPLOAD_FAILED = 28, OOBM_AUTH_ERROR = 29", + "name": "type", + "type": "short" }, - { - "description": "the project id of the bgp peer", - "name": "projectid", - "type": "string" - } - ], - "since": "4.20.0" + {} + ] }, { - "description": "Updates a port forwarding rule. Only the private port and the virtual machine can be updated.", + "description": "Creates a ACL rule in the given network (the network has to belong to VPC)", "isasync": true, - "name": "updatePortForwardingRule", + "name": "createNetworkACL", "params": [ { - "description": "the ID of the virtual machine for the port forwarding rule", + "description": "the ending port of ACL", "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", + "name": "endport", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "the private end port of the port forwarding rule", + "description": "The number of the ACL item, its ordering", "length": 255, - "name": "privateendport", + "name": "number", "required": false, "type": "integer" }, { - "description": "an optional field, whether to the display the rule to the end user or not", + "description": "the starting port of ACL", "length": 255, - "name": "fordisplay", + "name": "startport", "required": false, - "since": "4.4", - "type": "boolean" + "type": "integer" }, { - "description": "the private start port of the port forwarding rule", + "description": "A description indicating why the ACL rule is required.", "length": 255, - "name": "privateport", + "name": "reason", + "required": false, + "type": "string" + }, + { + "description": "the protocol for the ACL rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number", + "length": 255, + "name": "protocol", + "required": true, + "type": "string" + }, + { + "description": "type of the ICMP message being sent", + "length": 255, + "name": "icmptype", "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.", + "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": "VM guest nic Secondary ip address for the port forwarding rule", + "description": "the traffic type for the ACL,can be ingress or egress, defaulted to ingress if not specified", "length": 255, - "name": "vmguestip", + "name": "traffictype", "required": false, - "since": "4.5", "type": "string" }, { - "description": "the ID of the port forwarding rule", + "description": "scl entry action, allow or deny", "length": 255, - "name": "id", - "related": "updatePortForwardingRule", - "required": true, - "since": "4.4", + "name": "action", + "required": false, + "type": "string" + }, + { + "description": "error code for this ICMP message", + "length": 255, + "name": "icmpcode", + "required": false, + "type": "integer" + }, + { + "description": "The network of the VM the ACL will be created for", + "length": 255, + "name": "networkid", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork", + "required": false, "type": "uuid" }, { - "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 rule to the end user or not", "length": 255, - "name": "customid", + "name": "fordisplay", "required": false, "since": "4.4", - "type": "string" + "type": "boolean" + }, + { + "description": "The network of the VM the ACL will be created for", + "length": 255, + "name": "aclid", + "related": "createNetworkACLList", + "required": false, + "type": "uuid" } ], - "related": "", + "related": "updateNetworkACLItem,moveNetworkAclItem", "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", - "name": "privateport", + "description": "the ID of the ACL this item belongs to", + "name": "aclid", "type": "string" }, { - "description": "is firewall for display to the regular user", + "description": "is rule for display to the regular user", "name": "fordisplay", "type": "boolean" }, { - "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 starting port of port forwarding rule's public port range", - "name": "publicport", + "description": "the name of the ACL this item belongs to", + "name": "aclname", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "Number of the ACL Item", + "name": "number", "type": "integer" }, { - "description": "the ending port of port forwarding rule's private port range", - "name": "publicendport", + "description": "the traffic type for the ACL", + "name": "traffictype", "type": "string" }, { - "description": "the VM name for the port forwarding rule", - "name": "virtualmachinename", + "description": "error code for this icmp message", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the ending port of ACL's port range", + "name": "endport", "type": "string" }, { - "description": "the protocol of the port forwarding rule", + "description": "the protocol of the ACL", "name": "protocol", "type": "string" }, { - "description": "the id of the guest network the port forwarding rule belongs to", - "name": "networkid", + "description": "Action of ACL Item. Allow/Deny", + "name": "action", "type": "string" }, { - "description": "the ending port of port forwarding rule's private port range", - "name": "privateendport", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "an explanation on why this ACL rule is being applied", + "name": "reason", "type": "string" }, { - "description": "the VM display name for the port forwarding rule", - "name": "virtualmachinedisplayname", + "description": "the starting port of ACL's port range", + "name": "startport", "type": "string" }, { - "description": "the list of resource tags associated with the rule", + "description": "the list of resource tags associated with the network ACLs", "name": "tags", "response": [ { - "description": "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 project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -129425,8 +130536,8 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -129435,695 +130546,601 @@ "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 ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" } ], "type": "list" }, - {}, { - "description": "the ID of the port forwarding rule", + "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", "type": "string" }, { - "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 public ip address for the port forwarding rule", - "name": "ipaddress", + "description": "the state of the rule", + "name": "state", "type": "string" }, {} ] }, { - "description": "Acquires and associates a public IP to an account.", + "description": "Resets the SSH Key for virtual machine. The virtual machine must be in a \"Stopped\" state. [async]", "isasync": true, - "name": "associateIpAddress", + "name": "resetSSHKeyForVirtualMachine", "params": [ { - "description": "the VPC you want the IP address to be associated with", + "description": "The ID of the virtual machine", "length": 255, - "name": "vpcid", - "related": "listVPCs,createVPC,listVPCs,updateVPC", - "required": false, + "name": "id", + "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,createVMFromBackup,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "required": true, "type": "uuid" }, { - "description": "an optional field, whether to the display the IP to the end user or not", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" - }, - { - "description": "The network this IP address should be associated to.", + "description": "an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "networkid", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork", + "name": "domainid", + "related": "listDomains", "required": false, "type": "uuid" }, { - "description": "IP Address to be associated", - "length": 255, - "name": "ipaddress", - "required": false, - "type": "string" - }, - { - "description": "region ID from where portable IP is to be associated.", + "description": "names of the ssh key pairs to be used to login to the virtual machine", "length": 255, - "name": "regionid", - "related": "", + "name": "keypairs", "required": false, - "type": "integer" + "since": "4.17", + "type": "list" }, { - "description": "Deploy VM for the project", + "description": "name of the ssh key pair used to login to the virtual machine", "length": 255, - "name": "projectid", - "related": "", + "name": "keypair", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the account to associate with this IP address", + "description": "an optional account for the ssh key. Must be used with domainId.", "length": 255, "name": "account", "required": false, "type": "string" }, { - "description": "the ID of the domain to associate with this IP address", - "length": 255, - "name": "domainid", - "related": "listDomains", - "required": false, - "type": "uuid" - }, - { - "description": "should be set to true if public IP is required to be transferable across zones, if not specified defaults to false", - "length": 255, - "name": "isportable", - "required": false, - "type": "boolean" - }, - { - "description": "the ID of the availability zone you want to acquire an public IP address from", + "description": "an optional project for the ssh key", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "projectid", + "related": "", "required": false, "type": "uuid" } ], - "related": "updateIpAddress,associateIpAddress,listPublicIpAddresses", + "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,createVMFromBackup,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "response": [ { - "description": "virtual machine type the ip address is assigned to", - "name": "virtualmachinetype", - "type": "string" - }, - { - "description": "VPC name the ip belongs to", - "name": "vpcname", - "type": "string" - }, - { - "description": "the VLAN associated with the IP address", - "name": "vlanname", - "type": "string" - }, - { - "description": "the domain the public IP address is associated with", - "name": "domain", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "path of the domain to which the public IP address belongs", - "name": "domainpath", - "type": "string" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "the project name of the address", + "description": "the project name of the vm", "name": "project", "type": "string" }, { - "description": "public IP address id", - "name": "id", - "type": "string" - }, - { - "description": "is public IP portable across the zones", - "name": "isportable", - "type": "boolean" - }, - { - "description": "whether the ip address has Firewall/PortForwarding/LoadBalancing rules defined", - "name": "hasrules", - "type": "boolean" - }, - { - "description": "true if range is dedicated for external network providers", - "name": "forprovider", - "type": "boolean" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the name of the zone the public IP address belongs to", - "name": "zonename", - "type": "string" - }, - { - "description": "virtual machine (dnat) ip address (not null only for static nat Ip)", - "name": "vmipaddress", - "type": "string" - }, - { - "description": "the name of the Network associated with the IP address", - "name": "associatednetworkname", - "type": "string" - }, - {}, - { - "description": "State of the ip address. Can be: Allocating, Allocated, Releasing, Reserved and Free", - "name": "state", - "type": "string" - }, - {}, - { - "description": "the domain ID the public IP address is associated with", - "name": "domainid", - "type": "string" - }, - { - "description": "is public ip for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "true if the IP address is a source nat address, false otherwise", - "name": "issourcenat", - "type": "boolean" - }, - { - "description": "the name of the Network where ip belongs to", - "name": "networkname", - "type": "string" - }, - { - "description": "the ID of the VLAN associated with the IP address. This parameter is visible to ROOT admins only", - "name": "vlanid", - "type": "string" - }, - { - "description": "true if this ip is system ip (was allocated as a part of deployVm or createLbRule)", - "name": "issystem", - "type": "boolean" - }, - { - "description": "the account the public IP address is associated with", - "name": "account", - "type": "string" - }, - { - "description": "date the public IP address was acquired", - "name": "allocated", - "type": "date" - }, - { - "description": "the ID of the Network where ip belongs to", - "name": "networkid", - "type": "string" - }, - { - "description": "public IP address", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the ID of the zone the public IP address belongs to", - "name": "zoneid", - "type": "string" - }, - { - "description": "true if this ip is for static nat, false otherwise", - "name": "isstaticnat", - "type": "boolean" - }, - { - "description": "the virtual network for the IP address", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "description": "virtual machine id the ip address is assigned to", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "VPC id the ip belongs to", - "name": "vpcid", - "type": "string" - }, - { - "description": "the project id of the ipaddress", + "description": "the project id of the vm", "name": "projectid", "type": "string" }, { - "description": "virtual machine display name the ip address is assigned to (not null only for static nat Ip)", - "name": "virtualmachinedisplayname", - "type": "string" - }, - { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "the VM's primary IP address", + "name": "ipaddress", "type": "string" }, { - "description": "the ID of the Network associated with the IP address", - "name": "associatednetworkid", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "the list of resource tags associated with ip address", - "name": "tags", + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", "response": [ { - "description": "id of the resource", - "name": "resourceid", + "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": "resource type", - "name": "resourcetype", + "description": "the project name of the group", + "name": "project", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "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 ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "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 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": "set" + }, + { + "description": "the domain name of the security group", + "name": "domain", "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": "tag key name", - "name": "key", - "type": "string" + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" }, { - "description": "the account associated with the tag", + "description": "the account owning the security group", "name": "account", "type": "string" }, { - "description": "the ID of the domain associated with the tag", + "description": "the domain ID of the security group", "name": "domainid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the project id of the group", + "name": "projectid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the description of the security group", + "name": "description", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "virtual machine name the ip address is assigned to", - "name": "virtualmachinename", - "type": "string" - }, - { - "description": "purpose of the IP address. In Acton this value is not null for Ips with isSystem=true, and can have either StaticNat or LB value", - "name": "purpose", - "type": "string" - }, - { - "description": "true if range is dedicated for System VMs", - "name": "forsystemvms", - "type": "boolean" - } - ] - }, - { - "description": "Get the SF Volume Access Group IDs", - "isasync": false, - "name": "getSolidFireVolumeAccessGroupIds", - "params": [ - { - "description": "Cluster UUID", - "length": 255, - "name": "clusterid", - "required": true, - "type": "string" - }, - { - "description": "Storage Pool UUID", - "length": 255, - "name": "storageid", - "required": true, - "type": "string" - } - ], - "related": "", - "response": [ - {}, - {}, - { - "description": "SolidFire Volume Access Group Ids", - "name": "solidFireVolumeAccessGroupIds", - "type": "long[]" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", + "response": [ + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "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 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", + "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 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": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "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 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": "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 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": "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": "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 ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "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" + } + ], + "type": "set" + } + ], + "type": "set" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ] - }, - { - "description": "Delete site to site vpn connection", - "isasync": true, - "name": "deleteVpnConnection", - "params": [ - { - "description": "id of vpn connection", - "length": 255, + "description": "the ID of the virtual machine", "name": "id", - "related": "", - "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": "Lists all alerts types", - "isasync": false, - "name": "listAlertTypes", - "params": [], - "related": "listAlerts", - "response": [ - { - "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", + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "description of the alert", - "name": "description", - "type": "string" - }, - {}, - { - "description": "the name of the alert", - "name": "name", - "type": "string" - }, - { - "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": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, {}, { - "description": "the id of the alert", - "name": "id", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" - } - ] - }, - { - "description": "Creates a ACL rule in the given network (the network has to belong to VPC)", - "isasync": true, - "name": "createNetworkACL", - "params": [ - { - "description": "the 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, - "name": "networkid", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork", - "required": false, - "type": "uuid" - }, - { - "description": "The network of the VM the ACL will be created for", - "length": 255, - "name": "aclid", - "related": "createNetworkACLList", - "required": false, - "type": "uuid" }, { - "description": "A description indicating why the ACL rule is required.", - "length": 255, - "name": "reason", - "required": false, + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "The number of the ACL item, its ordering", - "length": 255, - "name": "number", - "required": false, - "type": "integer" - }, - { - "description": "the starting port of ACL", - "length": 255, - "name": "startport", - "required": false, - "type": "integer" + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, { - "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", + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", "type": "boolean" }, { - "description": "the traffic type for the ACL,can be ingress or egress, defaulted to ingress if not specified", - "length": 255, - "name": "traffictype", - "required": false, - "type": "string" + "description": "the video RAM size in MB", + "name": "videoram", + "type": "long" }, { - "description": "the ending port of ACL", - "length": 255, - "name": "endport", - "required": false, + "description": "the speed of each vCPU", + "name": "cpuspeed", "type": "integer" }, { - "description": "the protocol for the ACL rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number", - "length": 255, - "name": "protocol", - "required": true, + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "scl entry action, allow or deny", - "length": 255, - "name": "action", - "required": false, + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" - } - ], - "related": "updateNetworkACLItem,moveNetworkAclItem", - "response": [ - { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" }, { - "description": "the protocol of the ACL", - "name": "protocol", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the name of the ACL this item belongs to", - "name": "aclname", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "the ending port of ACL's port range", - "name": "endport", - "type": "string" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "description": "error code for this icmp message", - "name": "icmpcode", - "type": "integer" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "the state of the rule", - "name": "state", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "Number of the ACL Item", - "name": "number", - "type": "integer" + "description": "the state of the virtual machine", + "name": "state", + "type": "string" }, { - "description": "Action of ACL Item. Allow/Deny", - "name": "action", - "type": "string" + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" }, - {}, - {}, { - "description": "the list of resource tags associated with the network ACLs", + "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "tag key name", - "name": "key", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -130132,23 +131149,18 @@ "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 value", + "name": "value", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -130162,118 +131174,32 @@ "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": "tag key name", + "name": "key", + "type": "string" + }, + { + "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", - "type": "string" - }, - { - "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": "an explanation on why this ACL rule is being applied", - "name": "reason", - "type": "string" - }, - { - "description": "the traffic type for the ACL", - "name": "traffictype", - "type": "string" - }, - { - "description": "the ID of the ACL Item", - "name": "id", - "type": "string" - }, - { - "description": "the ID of the ACL this item belongs to", - "name": "aclid", - "type": "string" - } - ] - }, - { - "description": "Resets the SSH Key for virtual machine. The virtual machine must be in a \"Stopped\" state. [async]", - "isasync": true, - "name": "resetSSHKeyForVirtualMachine", - "params": [ - { - "description": "an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used.", - "length": 255, - "name": "domainid", - "related": "listDomains", - "required": false, - "type": "uuid" - }, - { - "description": "name of the ssh key pair used to login to the virtual machine", - "length": 255, - "name": "keypair", - "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", - "required": true, - "type": "uuid" + "type": "set" }, { - "description": "an optional account for the ssh key. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { - "description": "an optional project for the ssh key", - "length": 255, - "name": "projectid", - "related": "", - "required": false, - "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", - "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 read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" }, { "description": "the ID of the gpu card to which service offering is linked", @@ -130281,312 +131207,287 @@ "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", - "type": "string" - }, - { - "description": "Instance lease expiry date", - "name": "leaseexpirydate", - "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": "the maximum number of display heads", - "name": "maxheads", + "description": "the memory used by the VM in KiB", + "name": "memorykbs", "type": "long" }, { - "description": "the project name of the vm", - "name": "project", + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", + "description": "the list of nics associated with vm", + "name": "nic", "response": [ { - "description": "the ID of the affinity group", + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "the ID of the nic", "name": "id", "type": "string" }, { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", "type": "list" }, { - "description": "the name of the affinity group", - "name": "name", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "the account owning the affinity group", - "name": "account", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", + "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 isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "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 VLAN/VNI if available", + "name": "vlanid", + "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 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": "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": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" } ], "type": "set" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", - "type": "string" - }, - { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" - }, - { - "description": "the group name of the virtual machine", - "name": "group", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, + {}, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "true if vm has delete protection.", - "name": "deleteprotection", - "type": "boolean" - }, - { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" - }, - { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "the ID of the vgpu profile to which service offering is linked", - "name": "vgpuprofileid", - "type": "string" + "description": "the count of GPUs on the virtual machine", + "name": "gpucount", + "type": "integer" }, + {}, { - "description": "device ID of the root volume", - "name": "rootdeviceid", + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", "type": "long" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" - }, - { - "description": "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 high-availability is enabled, false otherwise", + "name": "haenable", "type": "boolean" }, - { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", - "type": "string" - }, - { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "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 received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "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 ISO attached to the virtual machine", - "name": "isoid", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" - }, - { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { - "description": "OS type id of the vm", - "name": "ostypeid", - "type": "string" - }, - { - "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": "the password (if exists) of the virtual machine", - "name": "password", + "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", + "description": "Instance lease expiry date", + "name": "leaseexpirydate", "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": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { @@ -130595,68 +131496,8 @@ "type": "string" }, { - "description": "the video RAM size in MB", - "name": "videoram", - "type": "long" - }, - { - "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", - "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": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" - }, - { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "Instance lease expiry action", - "name": "leaseexpiryaction", - "type": "string" - }, - { - "description": "the name of userdata used for the VM", - "name": "userdataname", - "type": "string" - }, - { - "description": "ssh key-pairs", - "name": "keypairs", - "type": "string" - }, - { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" - }, - { - "description": "the ID of the virtual machine", - "name": "id", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { @@ -130665,54 +131506,23 @@ "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": "State of the Service from LB rule", - "name": "servicestate", + "description": "the ID of the domain in which the virtual machine exists", + "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": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", "type": "long" }, - {}, - { - "description": "the format of the template for the virtual machine", - "name": "templateformat", - "type": "string" - }, - { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" - }, - { - "description": "the ID of the host for the virtual machine", - "name": "hostid", - "type": "string" - }, - { - "description": "Base64 string containing the user data", - "name": "userdata", - "type": "string" - }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { @@ -130720,299 +131530,172 @@ "name": "leaseduration", "type": "integer" }, - { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", - "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", - "type": "string" - }, - { - "description": "the account associated with the virtual machine", - "name": "account", - "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": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", - "type": "string" - }, - { - "description": "the name of the gpu card to which service offering is linked", - "name": "gpucardname", - "type": "string" - }, - { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", - "type": "string" - }, - { - "description": "the list of nics associated with vm", - "name": "nic", - "response": [ - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "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 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": "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 gateway of the nic", - "name": "gateway", - "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": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "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 ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "OS type id of the vm", + "name": "ostypeid", + "type": "string" + }, + { + "description": "the 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": "Instance lease expiry action", + "name": "leaseexpiryaction", + "type": "string" + }, + { + "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": "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", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", + "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 ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "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 name of the corresponding network", - "name": "networkname", + "description": "the type of the affinity group", + "name": "type", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "the name of the affinity group", + "name": "name", "type": "string" } ], "type": "set" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", + "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": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "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 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": "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 name of the vgpu profile to which service offering is linked", - "name": "vgpuprofilename", + "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 total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "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" - }, - { - "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": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - } - ], - "type": "set" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { "description": "User VM type", @@ -131020,8 +131703,13 @@ "type": "string" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "the account associated with the virtual machine", + "name": "account", + "type": "string" + }, + { + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { @@ -131029,397 +131717,90 @@ "name": "domain", "type": "string" }, + { + "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 password (if exists) of the virtual machine", + "name": "password", + "type": "string" + }, + { + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", + "type": "string" + }, { "description": "device type of the root volume", "name": "rootdevicetype", "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "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 template for the virtual machine", - "name": "templatename", + "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": "the group name of the virtual machine", + "name": "group", + "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", + "description": "Base64 string containing the user data", + "name": "userdata", + "type": "string" + }, + { + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", + "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": "CPU arch of the VM", + "name": "arch", "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": "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": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "type": "string" } ] }, @@ -131429,58 +131810,58 @@ "name": "deleteManagementNetworkIpRange", "params": [ { - "description": "The vlan id the ip range sits on", + "description": "The starting IP address.", "length": 255, - "name": "vlan", + "name": "startip", "required": true, "type": "string" }, { - "description": "The starting IP address.", + "description": "UUID of POD, where the IP range belongs to.", "length": 255, - "name": "startip", + "name": "podid", + "related": "createManagementNetworkIpRange", "required": true, - "type": "string" + "type": "uuid" }, { - "description": "The ending IP address.", + "description": "The vlan id the ip range sits on", "length": 255, - "name": "endip", + "name": "vlan", "required": true, "type": "string" }, { - "description": "UUID of POD, where the IP range belongs to.", + "description": "The ending IP address.", "length": 255, - "name": "podid", - "related": "createManagementNetworkIpRange", + "name": "endip", "required": true, - "type": "uuid" + "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" }, { - "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" - } + {} ], "since": "4.11.0.0" }, @@ -131490,48 +131871,33 @@ "name": "addKubernetesSupportedVersion", "params": [ { - "description": "the minimum number of CPUs to be set with the Kubernetes version", + "description": "the semantic version of the Kubernetes version. It needs to be specified in MAJOR.MINOR.PATCH format", "length": 255, - "name": "mincpunumber", + "name": "semanticversion", "required": true, - "type": "integer" - }, - { - "description": "the CPU arch of the Kubernetes ISO. Valid options are: x86_64, aarch64", - "length": 255, - "name": "arch", - "required": false, - "since": "4.20", "type": "string" }, { - "description": "the ID of the zone in which Kubernetes supported version will be available", + "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": "zoneid", - "related": "listZones", + "name": "checksum", "required": false, - "type": "uuid" + "type": "string" }, { - "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" }, { - "description": "the semantic version of the Kubernetes version. It needs to be specified in MAJOR.MINOR.PATCH format", + "description": "the minimum number of CPUs to be set with the Kubernetes version", "length": 255, - "name": "semanticversion", + "name": "mincpunumber", "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" + "type": "integer" }, { "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", @@ -131542,9 +131908,9 @@ "type": "boolean" }, { - "description": "the URL of the binaries ISO for Kubernetes supported version", + "description": "the name of the Kubernetes supported version", "length": 255, - "name": "url", + "name": "name", "required": false, "type": "string" }, @@ -131554,61 +131920,70 @@ "name": "minmemory", "required": true, "type": "integer" + }, + { + "description": "the ID of the zone in which Kubernetes supported version will be available", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" + }, + { + "description": "the URL of the binaries ISO for Kubernetes supported version", + "length": 255, + "name": "url", + "required": false, + "type": "string" } ], - "related": "listKubernetesSupportedVersions,updateKubernetesSupportedVersion", + "related": "getUploadParamsForKubernetesSupportedVersion,listKubernetesSupportedVersions,updateKubernetesSupportedVersion", "response": [ { "description": "the name of the binaries ISO for Kubernetes supported version", "name": "isoname", "type": "string" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "Name of the Kubernetes supported version", "name": "name", "type": "string" }, { - "description": "whether Kubernetes supported version supports HA, multi-control nodes", - "name": "supportsha", + "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 arch of the binaries ISO for Kubernetes supported version", - "name": "arch", + "description": "the id of the binaries ISO for Kubernetes supported version", + "name": "isoid", "type": "string" }, - {}, { "description": "the id of the zone in which Kubernetes supported version is available", "name": "zoneid", "type": "string" }, { - "description": "the date when this Kubernetes supported version was created", - "name": "created", - "type": "date" - }, - {}, - { - "description": "the minimum RAM size in MB needed for the Kubernetes supported version", - "name": "minmemory", - "type": "integer" + "description": "the arch of the binaries ISO for Kubernetes supported version", + "name": "arch", + "type": "string" }, { - "description": "the id of the binaries ISO for Kubernetes supported version", - "name": "isoid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the state of the binaries ISO for Kubernetes supported version", - "name": "isostate", - "type": "string" + "description": "the date when this Kubernetes supported version was created", + "name": "created", + "type": "date" }, { "description": "Kubernetes semantic version", @@ -131616,19 +131991,25 @@ "type": "string" }, { - "description": "KVM Only: true if the ISO for the Kubernetes supported version is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", + "description": "whether Kubernetes supported version supports Autoscaling", + "name": "supportsautoscaling", "type": "boolean" }, { - "description": "the id of the Kubernetes supported version", - "name": "id", + "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", - "type": "integer" + "description": "whether Kubernetes supported version supports HA, multi-control nodes", + "name": "supportsha", + "type": "boolean" + }, + {}, + { + "description": "the name of the zone in which Kubernetes supported version is available", + "name": "zonename", + "type": "string" }, { "description": "the minimum number of CPUs needed for the Kubernetes supported version", @@ -131636,19 +132017,19 @@ "type": "integer" }, { - "description": "whether Kubernetes supported version supports Autoscaling", - "name": "supportsautoscaling", - "type": "boolean" + "description": "the id of the Kubernetes supported version", + "name": "id", + "type": "string" }, { - "description": "the name of the zone in which Kubernetes supported version is available", - "name": "zonename", + "description": "the state of the binaries ISO for Kubernetes supported version", + "name": "isostate", "type": "string" }, { - "description": "the enabled or disabled state of the Kubernetes supported version", - "name": "state", - "type": "string" + "description": "the minimum RAM size in MB needed for the Kubernetes supported version", + "name": "minmemory", + "type": "integer" } ] }, @@ -131665,6 +132046,14 @@ "required": false, "type": "uuid" }, + { + "description": "an optional domainId for the user data. If the account parameter is used, domainId must also be used.", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" + }, { "description": "an optional account for the user data. Must be used with domainId.", "length": 255, @@ -131679,13 +132068,6 @@ "required": true, "type": "string" }, - { - "description": "CNI Configuration content to be registered as User data", - "length": 1048576, - "name": "cniconfig", - "required": false, - "type": "string" - }, { "description": "comma separated list of variables declared in user data content", "length": 255, @@ -131694,20 +132076,25 @@ "type": "string" }, { - "description": "an optional domainId for the user data. If the account parameter is used, domainId must also be used.", - "length": 255, - "name": "domainid", - "related": "listDomains", + "description": "CNI Configuration content to be registered as User data", + "length": 1048576, + "name": "cniconfig", "required": false, - "type": "uuid" + "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", @@ -131718,12 +132105,6 @@ "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" @@ -131734,112 +132115,42 @@ "name": "linkUserDataToTemplate", "params": [ { - "description": "the ID of the template for the virtual machine", + "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": "templateid", - "related": "listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "name": "userdataid", + "related": "", "required": false, "type": "uuid" }, { - "description": "an optional override policy of the userdata. Possible values are - ALLOWOVERRIDE, APPEND, DENYOVERRIDE. Default policy is allowoverride", + "description": "the ID of the ISO for the virtual machine", "length": 255, - "name": "userdatapolicy", + "name": "isoid", + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the ID of the userdata that has to be linked to template/ISO. If not provided existing userdata will be unlinked from the template/ISO", + "description": "the ID of the template for the virtual machine", "length": 255, - "name": "userdataid", - "related": "", + "name": "templateid", + "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": "an optional override policy of the userdata. Possible values are - ALLOWOVERRIDE, APPEND, DENYOVERRIDE. Default policy is allowoverride", "length": 255, - "name": "isoid", - "related": "listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "name": "userdatapolicy", "required": false, - "type": "uuid" + "type": "string" } ], - "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", "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": "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", + "description": "the template name", + "name": "name", "type": "string" }, { @@ -131847,23 +132158,23 @@ "name": "tags", "response": [ { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -131872,73 +132183,113 @@ "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" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "resource type", + "name": "resourcetype", "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": "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" } ], "type": "set" }, + {}, + { + "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": "the project name of the template", "name": "project", "type": "string" }, { - "description": "The ID of extension linked to this template", - "name": "extensionid", - "type": "string" + "description": "the processor bit size", + "name": "bits", + "type": "int" }, { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", - "type": "string" + "description": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the name of userdata linked to this template", + "name": "userdataname", "type": "string" }, { - "description": "path of the Domain the template belongs to", - "name": "domainpath", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { "description": "the date this template was removed", "name": "removed", "type": "date" }, { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" + "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", + "name": "userdataparams", + "type": "string" + }, + { + "description": "the ID of the OS type for this template.", + "name": "ostypeid", + "type": "string" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "CPU Arch of the template", + "name": "arch", + "type": "string" + }, + { + "description": "the name of the domain to which the template belongs", + "name": "domain", + "type": "string" + }, + { + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", + "type": "boolean" }, { "description": "Base64 string representation of the resource icon", @@ -131946,50 +132297,49 @@ "type": "resourceiconresponse" }, { - "description": "the id of userdata linked to this template", - "name": "userdataid", - "type": "string" + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", + "type": "boolean" }, { - "description": "checksum of the template", - "name": "checksum", + "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 ID of the secondary storage host for the template", + "name": "hostid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the name of the OS type for this template.", + "name": "ostypename", + "type": "string" }, { - "description": "CPU Arch of the template", - "name": "arch", + "description": "the ID of the zone for this template", + "name": "zoneid", "type": "string" }, { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", - "type": "string" + "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", + "description": "the name of the secondary storage host for the template", + "name": "hostname", "type": "string" }, { - "description": "the type of the template", - "name": "templatetype", + "description": "the tag of this template", + "name": "templatetag", "type": "string" }, { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", - "type": "boolean" + "description": "the id of userdata linked to this template", + "name": "userdataid", + "type": "string" }, { "description": "true if the entity/resource has annotations", @@ -131997,28 +132347,33 @@ "type": "boolean" }, { - "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 status of the template", + "name": "status", "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 date this template was created", - "name": "created", - "type": "date" + "description": "The ID of extension linked to this template", + "name": "extensionid", + "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": "the name of userdata linked to this template", - "name": "userdataname", + "description": "the account name to which the template belongs", + "name": "account", "type": "string" }, { @@ -132027,100 +132382,126 @@ "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", "type": "string" }, + {}, { - "description": "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", + "type": "string" }, { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", "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": "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", + "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": "checksum of the template", + "name": "checksum", "type": "string" }, { - "description": "the name of the domain to which the template belongs", - "name": "domain", + "description": "path of the Domain the template belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", + "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", "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": "true if this template is a featured template, false otherwise", "name": "isfeatured", "type": "boolean" }, { - "description": "The name of extension linked to this template", - "name": "extensionname", - "type": "string" + "description": "the format of the template.", + "name": "format", + "type": "imageformat" }, { - "description": "the template ID", - "name": "id", - "type": "string" + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" }, { - "description": "the physical size of the template", - "name": "physicalsize", - "type": "long" + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", + "type": "boolean" }, { - "description": "the template name", - "name": "name", + "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 name of extension linked to this template", + "name": "extensionname", + "type": "string" }, - {}, { "description": "the project id of the template", "name": "projectid", "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": "the ID of the zone for this template", - "name": "zoneid", + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", + "type": "boolean" + }, + { + "description": "the template ID", + "name": "id", "type": "string" }, { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", + "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", + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", "type": "boolean" + }, + { + "description": "the template display text", + "name": "displaytext", + "type": "string" } ], "since": "4.18.0" @@ -132131,12 +132512,19 @@ "name": "listCustomActions", "params": [ { - "description": "Name of the custom action", + "description": "List by keyword", "length": 255, - "name": "name", + "name": "keyword", "required": false, "type": "string" }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, { "description": "uuid of the custom action", "length": 255, @@ -132146,33 +132534,33 @@ "type": "uuid" }, { - "description": "List by keyword", + "description": "uuid of the extension", "length": 255, - "name": "keyword", + "name": "extensionid", + "related": "listExtensions,updateExtension", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "", + "description": "ID of a resource for actions", "length": 255, - "name": "pagesize", + "name": "resourceid", "required": false, - "type": "integer" + "type": "string" }, { - "description": "ID of a resource for actions", + "description": "Name of the custom action", "length": 255, - "name": "resourceid", + "name": "name", "required": false, "type": "string" }, { - "description": "uuid of the extension", + "description": "Type of the resource for actions", "length": 255, - "name": "extensionid", - "related": "listExtensions,updateExtension", + "name": "resourcetype", "required": false, - "type": "uuid" + "type": "string" }, { "description": "List actions whether they are enabled or not", @@ -132184,66 +132572,38 @@ { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" - }, - { - "description": "Type of the resource for actions", - "length": 255, - "name": "resourcetype", - "required": false, - "type": "string" } ], "related": "", "response": [ { - "description": "Whether the custom action is enabled or not", - "name": "enabled", - "type": "boolean" - }, - { - "description": "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": "Name of the parameter", + "name": "name", + "type": "string" + }, + { + "description": "Type of the parameter", + "name": "type", + "type": "string" + }, { "description": "Whether the parameter is required or not", "name": "required", @@ -132254,42 +132614,63 @@ "name": "valueoptions", "type": "list" }, - { - "description": "Type of the parameter", - "name": "type", - "type": "string" - }, { "description": "Validation format for value of the parameter. Available for specific types", "name": "validationformat", "type": "string" - }, - { - "description": "Name of the parameter", - "name": "name", - "type": "string" } ], "type": "list" }, + {}, + { + "description": "Details of the custom action", + "name": "details", + "type": "map" + }, + { + "description": "ID of the custom action", + "name": "id", + "type": "string" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "Resource type for which the action is available", - "name": "resourcetype", + "description": "Name of the custom action", + "name": "name", "type": "string" }, { - "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": "ID of the custom action", - "name": "id", + "description": "Whether the custom action is enabled or not", + "name": "enabled", + "type": "boolean" + }, + { + "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": "Message that will be used on successful execution of the action", + "name": "successmessage", + "type": "string" + }, + { + "description": "Name of the extension that this custom action belongs to", + "name": "extensionname", "type": "string" }, { @@ -132297,15 +132678,15 @@ "name": "jobstatus", "type": "integer" }, - { - "description": "List of role types allowed for the custom action", - "name": "allowedroletypes", - "type": "list" - }, { "description": "Message that will be used on failure during execution of the action", "name": "errormessage", "type": "string" + }, + { + "description": "Specifies the timeout in seconds to wait for the action to complete before failing", + "name": "timeout", + "type": "integer" } ], "since": "4.21.0" @@ -132316,55 +132697,49 @@ "name": "listGlobalLoadBalancerRules", "params": [ { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, - { - "description": "", + "description": "region ID", "length": 255, - "name": "page", + "name": "regionid", + "related": "", "required": false, "type": "integer" }, { - "description": "the ID of the global 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": "id", - "related": "listGlobalLoadBalancerRules,updateGlobalLoadBalancerRule", + "name": "listall", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "List resources by tags (key/value pairs)", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "tags", + "name": "isrecursive", "required": false, - "type": "map" + "type": "boolean" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources 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 global load balancer rule", "length": 255, - "name": "listall", + "name": "id", + "related": "listGlobalLoadBalancerRules,updateGlobalLoadBalancerRule", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "region ID", + "description": "", "length": 255, - "name": "regionid", - "related": "", + "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.", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "isrecursive", + "name": "projectid", + "related": "", "required": false, - "type": "boolean" + "type": "uuid" }, { "description": "list only resources belonging to the domain specified", @@ -132375,12 +132750,18 @@ "type": "uuid" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "", "length": 255, - "name": "projectid", - "related": "", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" + }, + { + "description": "List resources by tags (key/value pairs)", + "length": 255, + "name": "tags", + "required": false, + "type": "map" }, { "description": "List by keyword", @@ -132390,18 +132771,23 @@ "type": "string" }, { - "description": "", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "pagesize", + "name": "account", "required": false, - "type": "integer" + "type": "string" } ], "related": "updateGlobalLoadBalancerRule", "response": [ { - "description": "the account of the load balancer rule", - "name": "account", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "session persistence method used for the global load balancer", + "name": "gslbstickysessionmethodname", "type": "string" }, { @@ -132409,39 +132795,73 @@ "name": "domain", "type": "string" }, - {}, { "description": "List of load balancer rules that are part of GSLB rule", "name": "loadbalancerrule", "response": [ + { + "description": "the project id of the load balancer", + "name": "projectid", + "type": "string" + }, + { + "description": "the public port", + "name": "publicport", + "type": "string" + }, + { + "description": "the domain ID of the load balancer rule", + "name": "domainid", + "type": "string" + }, + { + "description": "the load balancer algorithm (source, roundrobin, leastconn)", + "name": "algorithm", + "type": "string" + }, { "description": "the project name of the load balancer", "name": "project", "type": "string" }, + { + "description": "the description of the load balancer", + "name": "description", + "type": "string" + }, + { + "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 load balancer", "name": "name", "type": "string" }, { - "description": "the private port", - "name": "privateport", + "description": "the CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { - "description": "the project id of the load balancer", - "name": "projectid", + "description": "the public ip address", + "name": "publicip", "type": "string" }, { - "description": "the domain ID of the load balancer rule", - "name": "domainid", + "description": "the state of the rule", + "name": "state", "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" }, { @@ -132450,8 +132870,33 @@ "type": "string" }, { - "description": "the id of the guest network the lb rule belongs to", - "name": "networkid", + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the load balancer rule ID", + "name": "id", + "type": "string" + }, + { + "description": "the public ip address id", + "name": "publicipid", + "type": "string" + }, + { + "description": "the private port", + "name": "privateport", + "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", "type": "string" }, { @@ -132459,23 +132904,23 @@ "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "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" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -132484,13 +132929,13 @@ "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 project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -132499,87 +132944,27 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], "type": "list" }, - { - "description": "path of the domain to which the load balancer rule belongs", - "name": "domainpath", - "type": "string" - }, - { - "description": "the load balancer algorithm (source, roundrobin, leastconn)", - "name": "algorithm", - "type": "string" - }, - { - "description": "the public port", - "name": "publicport", - "type": "string" - }, - { - "description": "the state of the rule", - "name": "state", - "type": "string" - }, - { - "description": "the load balancer rule ID", - "name": "id", - "type": "string" - }, - { - "description": "the CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,).", - "name": "cidrlist", - "type": "string" - }, { "description": "the domain of the load balancer rule", "name": "domain", "type": "string" - }, - { - "description": "the public ip address", - "name": "publicip", - "type": "string" - }, - { - "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", - "type": "string" - }, - { - "description": "the public ip address id", - "name": "publicipid", - "type": "string" - }, - { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the id of the zone the rule belongs to", - "name": "zoneid", - "type": "string" } ], "type": "list" @@ -132590,28 +132975,23 @@ "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 project name of the load balancer", + "name": "project", "type": "string" }, { - "description": "path of the domain to which the load balancer rule belongs", - "name": "domainpath", - "type": "string" + "description": "Region Id in which global load balancer is created", + "name": "regionid", + "type": "integer" }, { - "description": "the domain ID of the load balancer rule", - "name": "domainid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Load balancing method used for the global load balancer", - "name": "gslblbmethod", + "description": "the account of the load balancer rule", + "name": "account", "type": "string" }, { @@ -132619,14 +132999,19 @@ "name": "projectid", "type": "string" }, + { + "description": "global load balancer rule ID", + "name": "id", + "type": "string" + }, { "description": "DNS domain name given for the global load balancer", "name": "gslbdomainname", "type": "string" }, { - "description": "the project name of the load balancer", - "name": "project", + "description": "Load balancing method used for the global load balancer", + "name": "gslblbmethod", "type": "string" }, { @@ -132635,103 +133020,99 @@ "type": "string" }, { - "description": "the description of the global load balancer rule", - "name": "description", + "description": "the domain ID of the load balancer rule", + "name": "domainid", "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": "path of the domain to which the load balancer rule belongs", + "name": "domainpath", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the description of the global load balancer rule", + "name": "description", "type": "string" }, {} ] }, { - "description": "Updates a disk offering.", - "isasync": false, - "name": "deleteDiskOffering", + "description": "Release the dedication for cluster", + "isasync": true, + "name": "releaseDedicatedCluster", "params": [ { - "description": "ID of the disk offering", + "description": "the ID of the Cluster", "length": 255, - "name": "id", - "related": "", + "name": "clusterid", + "related": "addCluster,updateCluster", "required": true, "type": "uuid" } ], "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, {}, - {} + { + "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": "Release the dedication for cluster", - "isasync": true, - "name": "releaseDedicatedCluster", + "description": "Updates a disk offering.", + "isasync": false, + "name": "deleteDiskOffering", "params": [ { - "description": "the ID of the Cluster", + "description": "ID of the disk offering", "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", + "name": "id", + "related": "", "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": "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" } ] }, @@ -132752,8 +133133,8 @@ "related": "", "response": [ { - "description": "Name of the container cluster", - "name": "name", + "description": "the config data of the cluster", + "name": "configdata", "type": "string" }, { @@ -132761,15 +133142,15 @@ "name": "jobid", "type": "string" }, - {}, { "description": "the id of the container cluster", "name": "id", "type": "string" }, + {}, { - "description": "the config data of the cluster", - "name": "configdata", + "description": "Name of the container cluster", + "name": "name", "type": "string" }, { @@ -132805,12 +133186,12 @@ "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", @@ -132834,27 +133215,27 @@ } ], "response": [ - {}, - {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" } ], "since": "4.9.0" @@ -132874,6 +133255,12 @@ } ], "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", @@ -132881,19 +133268,13 @@ }, {}, { - "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" } ] @@ -132904,12 +133285,11 @@ "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 by keyword", "length": 255, - "name": "fetchhealthcheckresults", + "name": "keyword", "required": false, - "since": "4.14", - "type": "boolean" + "type": "string" }, { "description": "List Internal LB VMs by VPC", @@ -132919,29 +133299,6 @@ "required": false, "type": "uuid" }, - { - "description": "the state of the Internal LB VM", - "length": 255, - "name": "state", - "required": false, - "type": "string" - }, - { - "description": "the Zone ID of the Internal LB VM", - "length": 255, - "name": "zoneid", - "related": "listZones", - "required": false, - "type": "uuid" - }, - { - "description": "list by network id", - "length": 255, - "name": "networkid", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork", - "required": false, - "type": "uuid" - }, { "description": "", "length": 255, @@ -132958,10 +133315,10 @@ "type": "uuid" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "list by network id", "length": 255, - "name": "projectid", - "related": "", + "name": "networkid", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork", "required": false, "type": "uuid" }, @@ -132973,49 +133330,12 @@ "type": "string" }, { - "description": "the host ID of the Internal LB VM", - "length": 255, - "name": "hostid", - "related": "declareHostAsDegraded,reconnectHost", - "required": false, - "type": "uuid" - }, - { - "description": "the name of the Internal LB VM", - "length": 255, - "name": "name", - "required": false, - "type": "string" - }, - { - "description": "if true is passed for this parameter, list only VPC Internal LB VMs", - "length": 255, - "name": "forvpc", - "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 keyword", + "description": "the state of the Internal LB VM", "length": 255, - "name": "keyword", + "name": "state", "required": false, "type": "string" }, - { - "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 Pod ID of the Internal LB VM", "length": 255, @@ -133032,218 +133352,108 @@ "type": "boolean" }, { - "description": "", + "description": "if true is passed for this parameter, list only VPC Internal LB VMs", "length": 255, - "name": "pagesize", + "name": "forvpc", "required": false, - "type": "integer" - } - ], - "related": "listRouters", - "response": [ - { - "description": "the project id of the ipaddress", - "name": "projectid", - "type": "string" - }, - { - "description": "the Zone ID for the router", - "name": "zoneid", - "type": "string" - }, - { - "description": "the ID of the corresponding guest network", - "name": "guestnetworkid", - "type": "string" - }, - { - "description": "the version of template", - "name": "version", - "type": "string" - }, - { - "description": "the version of the code / software in the router", - "name": "softwareversion", - "type": "string" - }, - { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", - "type": "string" - }, - { - "description": "path of the Domain the router belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the guest netmask for the router", - "name": "guestnetmask", - "type": "string" - }, - { - "description": "the domain ID associated with the router", - "name": "domainid", - "type": "string" - }, - { - "description": "the guest IP address for the router", - "name": "guestipaddress", - "type": "string" - }, - { - "description": "the name of the router", - "name": "name", - "type": "string" - }, - { - "description": "the domain associated with the router", - "name": "domain", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the version of scripts", - "name": "scriptsversion", - "type": "string" - }, - { - "description": "the host ID for the router", - "name": "hostid", - "type": "string" - }, - { - "description": "true if the router template requires upgrader", - "name": "requiresupgrade", - "type": "boolean" - }, - { - "description": "the link local IP address for the router", - "name": "linklocalip", - "type": "string" - }, - { - "description": "the state of the router", - "name": "state", - "type": "state" - }, - { - "description": "VPC the router belongs to", - "name": "vpcid", - "type": "string" - }, - { - "description": "the template name for the router", - "name": "templatename", - "type": "string" - }, - { - "description": "true if any health checks had failed", - "name": "healthchecksfailed", - "type": "boolean" - }, - { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", - "type": "string" - }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, - { - "description": "the Pod ID for the router", - "name": "podid", - "type": "string" - }, - { - "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": "CPU arch of the router", - "name": "arch", - "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 public MAC address for the router", - "name": "publicmacaddress", - "type": "string" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the link local MAC address for the router", - "name": "linklocalmacaddress", - "type": "string" + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "", + "required": false, + "type": "uuid" }, { - "description": "the state of redundant virtual router", - "name": "redundantstate", - "type": "string" + "description": "the Zone ID of the Internal LB VM", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "if true is passed for this parameter, also fetch last executed health check results for the VM. Default is false", + "length": 255, + "name": "fetchhealthcheckresults", + "required": false, + "since": "4.14", "type": "boolean" }, { - "description": "the template ID for the router", - "name": "templateid", - "type": "string" + "description": "the host ID of the Internal LB VM", + "length": 255, + "name": "hostid", + "related": "declareHostAsDegraded,reconnectHost", + "required": false, + "type": "uuid" }, - {}, { - "description": "role of the domain router", - "name": "role", - "type": "string" + "description": "the ID of the Internal LB VM", + "length": 255, + "name": "id", + "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,createVMFromBackup,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "required": false, + "type": "uuid" }, { - "description": "the hostname for the router", - "name": "hostname", + "description": "the name of the Internal LB VM", + "length": 255, + "name": "name", + "required": false, "type": "string" - }, + } + ], + "related": "listRouters", + "response": [ { "description": "the list of nics associated with the router", "name": "nic", "response": [ { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", "type": "integer" }, { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "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", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { @@ -133252,89 +133462,89 @@ "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "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 type of the nic", - "name": "type", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" }, { - "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 gateway of the nic", - "name": "gateway", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", "type": "integer" }, { - "description": "the 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 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": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" }, { "description": "the ip address of the nic", @@ -133342,88 +133552,168 @@ "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "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 ID of the nic", + "name": "id", "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 ID of the nic", - "name": "id", - "type": "string" + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" } ], "type": "set" }, + { + "description": "the gateway for the router", + "name": "gateway", + "type": "string" + }, + { + "description": "path of the Domain the router belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "CPU arch of the router", + "name": "arch", + "type": "string" + }, + { + "description": "the version of template", + "name": "version", + "type": "string" + }, + { + "description": "the version of scripts", + "name": "scriptsversion", + "type": "string" + }, + { + "description": "the name of VPC the router belongs to", + "name": "vpcname", + "type": "string" + }, + { + "description": "the name of the router", + "name": "name", + "type": "string" + }, + { + "description": "the domain ID associated with the router", + "name": "domainid", + "type": "string" + }, + { + "description": "the state of redundant virtual router", + "name": "redundantstate", + "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 hostname for the router", + "name": "hostname", + "type": "string" + }, + { + "description": "the link local MAC address for the router", + "name": "linklocalmacaddress", + "type": "string" + }, + { + "description": "the Pod name for the router", + "name": "podname", + "type": "string" + }, + { + "description": "the public MAC address for the router", + "name": "publicmacaddress", + "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 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": "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 date this VPC was created", + "name": "lastupdated", + "type": "date" + }, + { + "description": "result of the health check if available", + "name": "success", + "type": "boolean" } ], "type": "list" }, { - "description": "the control state of the host for the router", - "name": "hostcontrolstate", - "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 Zone name for the router", + "name": "zonename", "type": "string" }, { - "description": "the network domain for the router", - "name": "networkdomain", + "description": "the first DNS for the router", + "name": "dns1", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the first IPv6 DNS for the router", + "name": "ip6dns1", "type": "string" }, { @@ -133431,34 +133721,40 @@ "name": "guestmacaddress", "type": "string" }, + {}, { - "description": "the date and time the router was created", - "name": "created", - "type": "date" + "description": "the template name for the router", + "name": "templatename", + "type": "string" }, { - "description": "the public IP address for the router", - "name": "publicip", + "description": "the ID of the corresponding public network", + "name": "publicnetworkid", "type": "string" }, { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", + "description": "the domain associated with the router", + "name": "domain", "type": "string" }, { - "description": "the gateway for the router", - "name": "gateway", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the Pod name for the router", - "name": "podname", + "description": "the second IPv6 DNS for the router", + "name": "ip6dns2", "type": "string" }, { - "description": "the ID of the corresponding public network", - "name": "publicnetworkid", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the second DNS for the router", + "name": "dns2", "type": "string" }, { @@ -133466,24 +133762,95 @@ "name": "jobstatus", "type": "integer" }, + { + "description": "the ID of the corresponding guest network", + "name": "guestnetworkid", + "type": "string" + }, + { + "description": "the link local netmask for the router", + "name": "linklocalnetmask", + "type": "string" + }, + { + "description": "the id of the router", + "name": "id", + "type": "string" + }, + { + "description": "the Pod ID for the router", + "name": "podid", + "type": "string" + }, + { + "description": "the Zone ID for the router", + "name": "zoneid", + "type": "string" + }, + { + "description": "the network domain for the router", + "name": "networkdomain", + "type": "string" + }, + { + "description": "the ID of the corresponding link local network", + "name": "linklocalnetworkid", + "type": "string" + }, { "description": "the account associated with the router", "name": "account", "type": "string" }, + { + "description": "the guest netmask for the router", + "name": "guestnetmask", + "type": "string" + }, + { + "description": "the host ID for the router", + "name": "hostid", + "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 state of the router", + "name": "state", + "type": "state" + }, + {}, + { + "description": "the guest IP address for the router", + "name": "guestipaddress", + "type": "string" + }, { "description": "the project name of the address", "name": "project", "type": "string" }, { - "description": "the second DNS for the router", - "name": "dns2", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the Zone name for the router", - "name": "zonename", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "role of the domain router", + "name": "role", "type": "string" }, { @@ -133492,26 +133859,45 @@ "type": "string" }, { - "description": "the id of the router", - "name": "id", + "description": "the version of the code / software in the router", + "name": "softwareversion", "type": "string" }, { - "description": "the first DNS for the router", - "name": "dns1", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", + "description": "the template ID for the router", + "name": "templateid", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the control state of the host for the router", + "name": "hostcontrolstate", "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 link local IP address for the router", + "name": "linklocalip", + "type": "string" + }, + { + "description": "the public IP address for the router", + "name": "publicip", + "type": "string" + } ] }, { @@ -133520,11 +133906,20 @@ "name": "listCiscoVnmcResources", "params": [ { - "description": "", + "description": "the Physical Network ID", "length": 255, - "name": "pagesize", + "name": "physicalnetworkid", + "related": "", "required": false, - "type": "integer" + "type": "uuid" + }, + { + "description": "Cisco VNMC resource ID", + "length": 255, + "name": "resourceid", + "related": "listCiscoVnmcResources", + "required": false, + "type": "uuid" }, { "description": "List by keyword", @@ -133541,24 +133936,20 @@ "type": "integer" }, { - "description": "the Physical Network ID", - "length": 255, - "name": "physicalnetworkid", - "related": "", - "required": false, - "type": "uuid" - }, - { - "description": "Cisco VNMC resource ID", + "description": "", "length": 255, - "name": "resourceid", - "related": "listCiscoVnmcResources", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" } ], "related": "", "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, {}, {}, { @@ -133568,11 +133959,6 @@ }, {}, {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, {}, {}, {} @@ -133583,6 +133969,13 @@ "isasync": true, "name": "executeClusterDrsPlan", "params": [ + { + "description": "Virtual Machine to destination host mapping. This parameter specifies the mapping between a vm and a host to migrate that VM. clusterid is required if this parameter is set.Format of this parameter: migrateto[vm-index].vm=&migrateto[vm-index].host= Where, [vm-index] indicates the index to identify the vm that you want to migrate, vm= indicates the UUID of the vm that you want to migrate, and host= indicates the UUID of the host where you want to migrate the vm. Example: migrateto[0].vm=<71f43cd6-69b0-4d3b-9fbc-67f50963d60b>&migrateto[0].host=&migrateto[1].vm=<88de0173-55c0-4c1c-a269-83d0279eeedf>&migrateto[1].host=<95d6e97c-6766-4d67-9a30-c449c15011d1>&migrateto[2].vm=<1b331390-59f2-4796-9993-bf11c6e76225>&migrateto[2].host=<41fdb564-9d3b-447d-88ed-7628f7640cbc>", + "length": 255, + "name": "migrateto", + "required": false, + "type": "map" + }, { "description": "ID of cluster", "length": 255, @@ -133590,42 +133983,41 @@ "related": "addCluster,updateCluster", "required": true, "type": "uuid" - }, - { - "description": "Virtual Machine to destination host mapping. This parameter specifies the mapping between a vm and a host to migrate that VM. clusterid is required if this parameter is set.Format of this parameter: migrateto[vm-index].vm=&migrateto[vm-index].host= Where, [vm-index] indicates the index to identify the vm that you want to migrate, vm= indicates the UUID of the vm that you want to migrate, and host= indicates the UUID of the host where you want to migrate the vm. Example: migrateto[0].vm=<71f43cd6-69b0-4d3b-9fbc-67f50963d60b>&migrateto[0].host=&migrateto[1].vm=<88de0173-55c0-4c1c-a269-83d0279eeedf>&migrateto[1].host=<95d6e97c-6766-4d67-9a30-c449c15011d1>&migrateto[2].vm=<1b331390-59f2-4796-9993-bf11c6e76225>&migrateto[2].host=<41fdb564-9d3b-447d-88ed-7628f7640cbc>", - "length": 255, - "name": "migrateto", - "required": false, - "type": "map" } ], "related": "", "response": [ - {}, { - "description": "Id of the cluster", - "name": "clusterid", + "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", + "description": "List of migrations", + "name": "migrations", + "type": "list" + }, + { + "description": "unique ID of the drs plan for cluster", + "name": "id", "type": "string" }, {}, { - "description": "List of migrations", - "name": "migrations", - "type": "list" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "Status of DRS Plan", - "name": "status", - "type": "status" + "description": "Id of the cluster", + "name": "clusterid", + "type": "string" }, + {}, + {}, { - "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" }, { @@ -133634,16 +134026,10 @@ "type": "type" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "unique ID of the drs plan for cluster", - "name": "id", - "type": "string" - }, - {} + "description": "Status of DRS Plan", + "name": "status", + "type": "status" + } ], "since": "4.19.0" }, @@ -133663,9 +134049,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" }, {}, { @@ -133673,17 +134059,17 @@ "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": "3.0.0" }, @@ -133692,6 +134078,13 @@ "isasync": false, "name": "uploadResourceIcon", "params": [ + { + "description": "list of resources to upload the icon/image for", + "length": 255, + "name": "resourceids", + "required": true, + "type": "list" + }, { "description": "Base64 string representation of the resource icon/image", "length": 2097152, @@ -133705,13 +134098,6 @@ "name": "resourcetype", "required": true, "type": "string" - }, - { - "description": "list of resources to upload the icon/image for", - "length": 255, - "name": "resourceids", - "required": true, - "type": "list" } ], "response": [ @@ -133720,22 +134106,22 @@ "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": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" } ], "since": "4.16.0.0" @@ -133756,21 +134142,31 @@ "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 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": "the arch of the binaries ISO for Kubernetes supported version", + "name": "arch", + "type": "string" + }, + { + "description": "the enabled or disabled state of the Kubernetes supported version", + "name": "state", + "type": "string" + }, + { + "description": "Name of the Kubernetes supported version", + "name": "name", "type": "string" }, { @@ -133784,30 +134180,24 @@ "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", + "description": "the state of the binaries ISO for Kubernetes supported version", + "name": "isostate", "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 state of the binaries ISO for Kubernetes supported version", - "name": "isostate", + "description": "Kubernetes semantic version", + "name": "semanticversion", "type": "string" }, { - "description": "the id of the Kubernetes supported version", - "name": "id", - "type": "string" + "description": "whether Kubernetes supported version supports HA, multi-control nodes", + "name": "supportsha", + "type": "boolean" }, { "description": "the minimum number of CPUs needed for the Kubernetes supported version", @@ -133815,45 +134205,41 @@ "type": "integer" }, { - "description": "the name of the binaries ISO for Kubernetes supported version", - "name": "isoname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "Kubernetes semantic version", - "name": "semanticversion", + "description": "the id of the Kubernetes supported version", + "name": "id", "type": "string" }, - {}, { - "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" }, { - "description": "whether Kubernetes supported version supports HA, multi-control nodes", - "name": "supportsha", + "description": "whether Kubernetes supported version supports Autoscaling", + "name": "supportsautoscaling", "type": "boolean" }, - { - "description": "Name of the Kubernetes supported version", - "name": "name", - "type": "string" - }, { "description": "the date when this Kubernetes supported version was created", "name": "created", "type": "date" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the zone in which Kubernetes supported version is available", + "name": "zonename", "type": "string" }, + {}, { - "description": "the arch of the binaries ISO for Kubernetes supported version", - "name": "arch", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -133872,27 +134258,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": "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" @@ -133921,47 +134307,47 @@ "related": "listGuestNetworkIpv6Prefixes", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "count of the available IPv6 subnets for the prefix.", + "name": "availablesubnets", + "type": "integer" }, { - "description": "id of the guest IPv6 prefix", - "name": "id", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "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", "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", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - { - "description": "count of the available IPv6 subnets for the prefix.", - "name": "availablesubnets", - "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", + "type": "string" + }, + { + "description": "guest IPv6 prefix", + "name": "prefix", + "type": "string" + }, + {}, + {}, { "description": "count of the total IPv6 subnets for the prefix.", "name": "totalsubnets", @@ -133976,11 +134362,12 @@ "name": "createRole", "params": [ { - "description": "Indicates whether the role will be visible to all users (public) or only to root admins (private). Default is true.", + "description": "ID of the role to be cloned from. Either roleid or type must be passed in", "length": 255, - "name": "ispublic", + "name": "roleid", + "related": "createRole,listRoles,updateRole", "required": false, - "type": "boolean" + "type": "uuid" }, { "description": "Creates a role with this unique name", @@ -133997,69 +134384,68 @@ "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). Default is true.", "length": 255, - "name": "type", + "name": "ispublic", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "ID of the role to be cloned from. Either roleid or type must be passed in", + "description": "The type of the role, valid options are: Admin, ResourceAdmin, DomainAdmin, User", "length": 255, - "name": "roleid", - "related": "createRole,listRoles,updateRole", + "name": "type", "required": false, - "type": "uuid" + "type": "string" } ], "related": "listRoles,updateRole", "response": [ { - "description": "the type of the role", - "name": "type", + "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": "the state of the role", - "name": "state", + "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", + "description": "true if role is default, false otherwise", + "name": "isdefault", "type": "boolean" }, { - "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": "the name of the role", - "name": "name", + "description": "the type of the role", + "name": "type", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "Indicates whether the role will be visible to all users (public) or only to root admins (private). If this parameter is not specified during the creation of the role its value will be defaulted to true (public).", + "name": "ispublic", + "type": "boolean" }, {}, - {}, { "description": "the 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 name of the role", + "name": "name", + "type": "string" } ], "since": "4.9.0" @@ -134070,24 +134456,26 @@ "name": "getUploadParamsForVolume", "params": [ { - "description": "Image store uuid", + "description": "the ID of the disk offering. This must be a custom sized offering since during upload of volume/template size is unknown.", "length": 255, - "name": "imagestoreuuid", + "name": "diskofferingid", + "related": "", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the name of the volume/template/iso", + "description": "an optional domainId. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "name", - "required": true, - "type": "string" + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" }, { - "description": "the format for the volume/template/iso. Possible values include QCOW2, OVA, and VHD.", + "description": "Image store uuid", "length": 255, - "name": "format", - "required": true, + "name": "imagestoreuuid", + "required": false, "type": "string" }, { @@ -134097,6 +134485,14 @@ "required": false, "type": "string" }, + { + "description": "Upload volume/template/iso for the project", + "length": 255, + "name": "projectid", + "related": "", + "required": false, + "type": "uuid" + }, { "description": "an optional accountName. Must be used with domainId.", "length": 255, @@ -134105,20 +134501,18 @@ "type": "string" }, { - "description": "an optional domainId. If the account parameter is used, domainId must also be used.", + "description": "the format for the volume/template/iso. Possible values include QCOW2, OVA, and VHD.", "length": 255, - "name": "domainid", - "related": "listDomains", - "required": false, - "type": "uuid" + "name": "format", + "required": true, + "type": "string" }, { - "description": "Upload volume/template/iso for the project", + "description": "the name of the volume/template/iso", "length": 255, - "name": "projectid", - "related": "", - "required": false, - "type": "uuid" + "name": "name", + "required": true, + "type": "string" }, { "description": "the ID of the zone the volume/template/iso is to be hosted on", @@ -134127,21 +134521,19 @@ "related": "listZones", "required": true, "type": "uuid" - }, - { - "description": "the ID of the disk offering. This must be a custom sized offering since during upload of volume/template size is unknown.", - "length": 255, - "name": "diskofferingid", - "related": "", - "required": false, - "type": "uuid" } ], "related": "getUploadParamsForTemplate,getUploadParamsForIso", "response": [ { - "description": "signature to be sent in the POST request.", - "name": "signature", + "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" }, { @@ -134150,8 +134542,8 @@ "type": "string" }, { - "description": "the timestamp after which the signature expires", - "name": "expires", + "description": "signature to be sent in the POST request.", + "name": "signature", "type": "string" }, { @@ -134160,21 +134552,15 @@ "type": "uuid" }, {}, - { - "description": "the UUID of the latest async 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": "POST url to upload the file to", - "name": "postURL", - "type": "url" + "description": "the timestamp after which the signature expires", + "name": "expires", + "type": "string" } ], "since": "4.6.0" @@ -134185,76 +134571,68 @@ "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": "used to specify the parameters values for the variables in userdata.", "length": 255, - "name": "customid", + "name": "userdatadetails", "required": false, - "since": "4.4", - "type": "string" - }, - { - "description": "the ID of the autoscale vm profile", - "length": 255, - "name": "id", - "related": "listAutoScaleVmProfiles,updateAutoScaleVmProfile", - "required": true, - "type": "uuid" + "since": "4.18.1", + "type": "map" }, { - "description": "the time allowed for existing connections to get closed before a vm is destroyed", + "description": "the service offering of the auto deployed virtual machine", "length": 255, - "name": "expungevmgraceperiod", + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", "required": false, - "type": "integer" + "since": "4.18.0", + "type": "uuid" }, { - "description": "the ID of the userdata", + "description": "an optional field, whether to the display the profile to the end user or not", "length": 255, - "name": "userdataid", - "related": "", + "name": "fordisplay", "required": false, - "since": "4.18.1", - "type": "uuid" + "since": "4.4", + "type": "boolean" }, { "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": "counterparam list. Example: counterparam[0].name=snmpcommunity&counterparam[0].value=public&counterparam[1].name=snmpport&counterparam[1].value=161", "length": 255, - "name": "fordisplay", + "name": "counterparam", "required": false, - "since": "4.4", - "type": "boolean" + "type": "map" }, { - "description": "the service offering of the auto deployed virtual machine", + "description": "the ID of the user used to launch and destroy the VMs", "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", + "name": "autoscaleuserid", + "related": "disableUser,getUser,listUsers,lockUser", "required": false, - "since": "4.18.0", "type": "uuid" }, { - "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": "the ID of the userdata", "length": 255, - "name": "counterparam", + "name": "userdataid", + "related": "", "required": false, - "type": "map" + "since": "4.18.1", + "type": "uuid" }, { "description": "parameters other than zoneId/serviceOfferringId/templateId of the auto deployed virtual machine. \nExample: otherdeployparams[0].name=serviceofferingid&otherdeployparams[0].value=a7fb50f6-01d9-11ed-8bc1-77f8f0228926&otherdeployparams[1].name=rootdisksize&otherdeployparams[1].value=10 .\nPossible parameters are \"rootdisksize\", \"diskofferingid\",\"size\", \"securitygroupids\", \"overridediskofferingid\", \"keypairs\", \"affinitygroupids'\" and \"networkids\".", @@ -134273,30 +134651,42 @@ "type": "string" }, { - "description": "used to specify the parameters values for the variables in userdata.", + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "userdatadetails", + "name": "customid", "required": false, - "since": "4.18.1", - "type": "map" + "since": "4.4", + "type": "string" + }, + { + "description": "the ID of the autoscale vm profile", + "length": 255, + "name": "id", + "related": "listAutoScaleVmProfiles,updateAutoScaleVmProfile", + "required": true, + "type": "uuid" } ], "related": "listAutoScaleVmProfiles", "response": [ { - "description": "the autoscale vm profile ID", - "name": "id", + "description": "the project id vm profile", + "name": "projectid", "type": "string" }, { - "description": "the project id vm profile", - "name": "projectid", + "description": "the template to be used while deploying a virtual machine", + "name": "templateid", "type": "string" }, - {}, { - "description": "the availability zone to be used while deploying a virtual machine", - "name": "zoneid", + "description": "Base64 encoded VM user data", + "name": "userdata", + "type": "string" + }, + { + "description": "the service offering to be used while deploying a virtual machine", + "name": "serviceofferingid", "type": "string" }, { @@ -134310,21 +134700,15 @@ "type": "string" }, { - "description": "the time allowed for existing connections to get closed before a vm is destroyed", - "name": "expungevmgraceperiod", - "type": "integer" - }, - {}, - { - "description": "Base64 encoded VM user data", - "name": "userdata", - "type": "string" + "description": "parameters other than zoneId/serviceOfferringId/templateId to be used while deploying a virtual machine", + "name": "otherdeployparams", + "type": "map" }, {}, { - "description": "the project name of the vm profile", - "name": "project", - "type": "string" + "description": "is profile for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { "description": "the name of userdata used for the VM", @@ -134332,40 +134716,29 @@ "type": "string" }, { - "description": "the domain name of the vm profile", - "name": "domain", + "description": "the autoscale vm profile ID", + "name": "id", "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "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": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "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", - "type": "boolean" - }, - { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "the domain name of the vm profile", + "name": "domain", "type": "string" }, { - "description": "parameters other than zoneId/serviceOfferringId/templateId to be used while deploying a virtual machine", - "name": "otherdeployparams", - "type": "map" + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "type": "string" }, { "description": "path of the domain to which the vm profile belongs", @@ -134373,24 +134746,37 @@ "type": "string" }, { - "description": "the ID of the user used to launch and destroy the VMs", - "name": "autoscaleuserid", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "the service offering to be used while deploying a virtual machine", - "name": "serviceofferingid", + "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", "type": "string" }, + {}, + {}, { - "description": "the template to be used while deploying a virtual machine", - "name": "templateid", + "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -134411,55 +134797,61 @@ "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 name of the autoscale vm group ", + "name": "name", + "type": "string" }, { - "description": "the date when this vm group was created", - "name": "created", - "type": "date" + "description": "the public ip address", + "name": "publicip", + "type": "string" }, { - "description": "the id of the guest network the lb rule belongs to", - "name": "associatednetworkid", + "description": "the load balancer rule ID", + "name": "lbruleid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the private port", + "name": "privateport", "type": "string" }, + {}, { - "description": "the number of available virtual machines (in Running, Starting, Stopping or Migrating state) in the vmgroup", - "name": "availablevirtualmachinecount", - "type": "int" + "description": "the autoscale profile that contains information about the vms in the vm group.", + "name": "vmprofileid", + "type": "string" }, { - "description": "the project name of the vm group", - "name": "project", + "description": "the autoscale vm group ID", + "name": "id", "type": "string" }, {}, { - "description": "the domain name of the vm group", - "name": "domain", - "type": "string" + "description": "list of scaledown autoscale policies", + "name": "scaledownpolicies", + "type": "list" }, { - "description": "the current state of the AutoScale Vm Group", - "name": "state", + "description": "the project id of the vm group", + "name": "projectid", "type": "string" }, { - "description": "the autoscale vm group ID", - "name": "id", + "description": "the domain name of the vm group", + "name": "domain", "type": "string" }, { - "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", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { "description": "path of the domain to which the vm group belongs", @@ -134467,8 +134859,13 @@ "type": "string" }, { - "description": "the autoscale profile that contains information about the vms in the vm group.", - "name": "vmprofileid", + "description": "the domain ID of the vm group", + "name": "domainid", + "type": "string" + }, + { + "description": "the current state of the AutoScale Vm Group", + "name": "state", "type": "string" }, { @@ -134477,14 +134874,14 @@ "type": "int" }, { - "description": "the public ip address", - "name": "publicip", - "type": "string" + "description": "the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number.", + "name": "minmembers", + "type": "int" }, { - "description": "list of scaleup autoscale policies", - "name": "scaleuppolicies", - "type": "list" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { "description": "the account owning the vm group", @@ -134492,48 +134889,28 @@ "type": "string" }, { - "description": "the public ip address id", - "name": "publicipid", - "type": "string" - }, - { - "description": "the domain ID of the vm group", - "name": "domainid", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "list of scaleup autoscale policies", + "name": "scaleuppolicies", + "type": "list" }, { - "description": "the lb provider of the guest network the lb rule belongs to", - "name": "lbprovider", + "description": "the project name of the vm group", + "name": "project", "type": "string" }, { - "description": "is group for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number.", - "name": "minmembers", + "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", - "type": "string" - }, - { - "description": "the private port", - "name": "privateport", + "description": "the name of the guest network the lb rule belongs to", + "name": "associatednetworkname", "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" }, { @@ -134542,16 +134919,25 @@ "type": "integer" }, { - "description": "the project id of the vm group", - "name": "projectid", + "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 lb provider of the guest network the lb rule belongs to", + "name": "lbprovider", "type": "string" }, { - "description": "list of scaledown autoscale policies", - "name": "scaledownpolicies", - "type": "list" + "description": "the public ip address id", + "name": "publicipid", + "type": "string" + }, + { + "description": "the date when this vm group was created", + "name": "created", + "type": "date" }, - {}, { "description": "the public port", "name": "publicport", @@ -134565,20 +134951,13 @@ "name": "listGuestNetworkIpv6Prefixes", "params": [ { - "description": "UUID of the IPv6 prefix.", + "description": "UUID of zone to which the IPv6 prefix belongs to.", "length": 255, - "name": "id", - "related": "listGuestNetworkIpv6Prefixes", + "name": "zoneid", + "related": "listZones", "required": false, "type": "uuid" }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, { "description": "", "length": 255, @@ -134587,10 +134966,10 @@ "type": "integer" }, { - "description": "UUID of zone to which the IPv6 prefix belongs to.", + "description": "UUID of the IPv6 prefix.", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "id", + "related": "listGuestNetworkIpv6Prefixes", "required": false, "type": "uuid" }, @@ -134600,24 +134979,21 @@ "name": "keyword", "required": false, "type": "string" + }, + { + "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": "count of the used IPv6 subnets for the prefix.", - "name": "usedsubnets", + "description": "count of the total IPv6 subnets for the prefix.", + "name": "totalsubnets", "type": "integer" }, { @@ -134625,10 +135001,11 @@ "name": "created", "type": "date" }, + {}, { - "description": "id of zone to which the IPv6 prefix belongs to.", - "name": "zoneid", - "type": "string" + "description": "count of the available IPv6 subnets for the prefix.", + "name": "availablesubnets", + "type": "integer" }, { "description": "the UUID of the latest async job acting on this object", @@ -134636,20 +135013,29 @@ "type": "string" }, { - "description": "count of the total IPv6 subnets for the prefix.", - "name": "totalsubnets", + "description": "count of the used IPv6 subnets for the prefix.", + "name": "usedsubnets", "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": "guest IPv6 prefix", + "name": "prefix", + "type": "string" + }, + { + "description": "id of zone to which the IPv6 prefix belongs to.", + "name": "zoneid", + "type": "string" } ], "since": "4.17.0" @@ -134668,19 +135054,19 @@ "type": "boolean" }, { - "description": "UUID of the Guest OS to hypervisor name Mapping", + "description": "Hypervisor specific name for this Guest OS", "length": 255, - "name": "id", - "related": "updateGuestOsMapping", + "name": "osnameforhypervisor", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "Hypervisor specific name for this Guest OS", + "description": "UUID of the Guest OS to hypervisor name Mapping", "length": 255, - "name": "osnameforhypervisor", + "name": "id", + "related": "updateGuestOsMapping", "required": true, - "type": "string" + "type": "uuid" } ], "related": "", @@ -134691,21 +135077,20 @@ "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": "standard display name for the Guest OS", + "name": "osdisplayname", "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", @@ -134713,23 +135098,24 @@ "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": "hypervisor specific name for the Guest OS", - "name": "osnameforhypervisor", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the Guest OS mapping", + "name": "id", "type": "string" }, { - "description": "is the mapping user defined", - "name": "isuserdefined", + "description": "hypervisor specific name for the Guest OS", + "name": "osnameforhypervisor", "type": "string" } ], @@ -134757,12 +135143,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", @@ -134773,11 +135164,6 @@ "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" } ] }, @@ -134787,17 +135173,9 @@ "name": "updateHostPassword", "params": [ { - "description": "the host ID", - "length": 255, - "name": "hostid", - "related": "declareHostAsDegraded,reconnectHost", - "required": false, - "type": "uuid" - }, - { - "description": "the new password for the host/cluster", + "description": "the username for the host/cluster", "length": 255, - "name": "password", + "name": "username", "required": true, "type": "string" }, @@ -134809,6 +135187,13 @@ "required": false, "type": "uuid" }, + { + "description": "the new password for the host/cluster", + "length": 255, + "name": "password", + "required": true, + "type": "string" + }, { "description": "if the password should also be updated on the hosts", "length": 255, @@ -134817,36 +135202,37 @@ "type": "boolean" }, { - "description": "the username for the host/cluster", + "description": "the host ID", "length": 255, - "name": "username", - "required": true, - "type": "string" + "name": "hostid", + "related": "declareHostAsDegraded,reconnectHost", + "required": false, + "type": "uuid" } ], "response": [ - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, - {}, { - "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" - } + }, + {} ] }, { @@ -134855,33 +135241,33 @@ "name": "createPortableIpRange", "params": [ { - "description": "Id of the Region", + "description": "the beginning IP address in the portable IP range", "length": 255, - "name": "regionid", - "related": "", + "name": "startip", "required": true, - "type": "integer" + "type": "string" }, { - "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" }, { - "description": "the beginning IP address in the portable IP range", + "description": "the ending IP address in the portable IP range", "length": 255, - "name": "startip", + "name": "endip", "required": true, "type": "string" }, { - "description": "the ending IP address in the portable IP range", + "description": "Id of the Region", "length": 255, - "name": "endip", + "name": "regionid", + "related": "", "required": true, - "type": "string" + "type": "integer" }, { "description": "the netmask of the portable IP range", @@ -134891,57 +135277,20 @@ "type": "string" }, { - "description": "VLAN id, if not specified defaulted to untagged", + "description": "the gateway for the portable IP range", "length": 255, - "name": "vlan", - "required": false, + "name": "gateway", + "required": true, "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", "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", @@ -134952,13 +135301,8 @@ "name": "portableipaddress", "response": [ { - "description": "date the portal IP address was acquired", - "name": "allocated", - "type": "date" - }, - { - "description": "public IP address", - "name": "ipaddress", + "description": "VPC the ip belongs to", + "name": "vpcid", "type": "string" }, { @@ -134967,29 +135311,34 @@ "type": "string" }, { - "description": "the account ID the portable IP address is associated with", - "name": "accountid", + "description": "public IP address", + "name": "ipaddress", "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": "Region Id in which global load balancer is created", + "name": "regionid", + "type": "integer" + }, { "description": "the physical network this belongs to", "name": "physicalnetworkid", "type": "string" }, { - "description": "the ID of the zone the public IP address belongs to", - "name": "zoneid", + "description": "the account ID the portable IP address is associated with", + "name": "accountid", "type": "string" }, { - "description": "Region Id in which global load balancer is created", - "name": "regionid", - "type": "integer" + "description": "State of the ip address. Can be: Allocating, Allocated, Releasing and Free", + "name": "state", + "type": "string" }, { "description": "the domain ID the portable IP address is associated with", @@ -134997,12 +135346,49 @@ "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 end ip of the portable IP range", + "name": "endip", + "type": "string" + }, + {}, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "portable IP range ID", + "name": "id", + "type": "string" + }, + { + "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 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" } ], "since": "4.2.0" @@ -135021,32 +135407,32 @@ "type": "uuid" }, { - "description": "The end date range for the Webhook delivery (use format \"yyyy-MM-dd\" or \"yyyy-MM-dd HH:mm:ss\"). All deliveries having end date equal to or before the specified date will be considered.", + "description": "The start date range for the Webhook delivery (use format \"yyyy-MM-dd\" or \"yyyy-MM-dd HH:mm:ss\"). All deliveries having start date equal to or after the specified date will be considered.", "length": 255, - "name": "enddate", + "name": "startdate", "required": false, "type": "date" }, { - "description": "The start date range for the Webhook delivery (use format \"yyyy-MM-dd\" or \"yyyy-MM-dd HH:mm:ss\"). All deliveries having start date equal to or after the specified date will be considered.", + "description": "The 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": "startdate", + "name": "enddate", "required": false, "type": "date" }, { - "description": "The ID of the Webhook delivery", + "description": "The ID of the Webhook", "length": 255, - "name": "id", - "related": "", + "name": "webhookid", + "related": "createWebhook", "required": false, "type": "uuid" }, { - "description": "The ID of the Webhook", + "description": "The ID of the Webhook delivery", "length": 255, - "name": "webhookid", - "related": "createWebhook", + "name": "id", + "related": "", "required": false, "type": "uuid" } @@ -135057,57 +135443,189 @@ "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" }, - {}, {} ], "since": "4.20.0" }, { - "description": "Updates an existing cluster", + "description": "Update the extension", "isasync": false, - "name": "updateCluster", + "name": "updateExtension", "params": [ { - "description": "the ID of the Cluster", + "description": "Description of the extension", + "length": 255, + "name": "description", + "required": false, + "type": "string" + }, + { + "description": "The ID of the extension", "length": 255, "name": "id", - "related": "addCluster,updateCluster", + "related": "listExtensions,updateExtension", "required": true, "type": "uuid" }, { - "description": "whether this cluster is managed by cloudstack", + "description": "Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].endpoint.url=urlvalue", "length": 255, - "name": "managedstate", + "name": "details", "required": false, - "type": "string" + "type": "map" }, { - "description": "hypervisor type of the cluster", + "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": "clustertype", + "name": "cleanupdetails", + "required": false, + "type": "boolean" + }, + { + "description": "Only honored when type is Orchestrator. Whether prepare VM is needed or not", + "length": 255, + "name": "orchestratorrequirespreparevm", + "required": false, + "type": "boolean" + }, + { + "description": "State of the extension", + "length": 255, + "name": "state", "required": false, "type": "string" + } + ], + "related": "listExtensions", + "response": [ + { + "description": "Creation timestamp of the extension", + "name": "created", + "type": "date" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the cluster name", + "description": "Type of the extension", + "name": "type", + "type": "string" + }, + { + "description": "Removal timestamp of the extension, if applicable", + "name": "removed", + "type": "date" + }, + { + "description": "The path of the entry point fo the extension", + "name": "path", + "type": "string" + }, + { + "description": "Description of the extension", + "name": "description", + "type": "string" + }, + { + "description": "The state of the extension", + "name": "state", + "type": "string" + }, + { + "description": "True if the extension is added by admin", + "name": "isuserdefined", + "type": "boolean" + }, + {}, + { + "description": "The details of the extension", + "name": "details", + "type": "map" + }, + {}, + { + "description": "ID of the extension", + "name": "id", + "type": "string" + }, + { + "description": "Name of the extension", + "name": "name", + "type": "string" + }, + {}, + { + "description": "List of resources to which extension is registered to", + "name": "resources", + "response": [ + { + "description": "Name of the resource associated with this mapping", + "name": "name", + "type": "string" + }, + { + "description": "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": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "True if the extension path is in ready state across management servers", + "name": "pathready", + "type": "boolean" + } + ], + "since": "4.21.0" + }, + { + "description": "Updates an existing cluster", + "isasync": false, + "name": "updateCluster", + "params": [ + { + "description": "hypervisor type of the cluster", "length": 255, - "name": "clustername", + "name": "clustertype", "required": false, "type": "string" }, @@ -135119,6 +135637,13 @@ "since": "4.20", "type": "string" }, + { + "description": "hypervisor type of the cluster", + "length": 255, + "name": "hypervisor", + "required": false, + "type": "string" + }, { "description": "Allocation state of this cluster for allocation of new resources", "length": 255, @@ -135135,43 +135660,47 @@ "type": "map" }, { - "description": "hypervisor type of the cluster", + "description": "the cluster name", "length": 255, - "name": "hypervisor", + "name": "clustername", + "required": false, + "type": "string" + }, + { + "description": "the ID of the Cluster", + "length": 255, + "name": "id", + "related": "addCluster,updateCluster", + "required": true, + "type": "uuid" + }, + { + "description": "whether this cluster is managed by cloudstack", + "length": 255, + "name": "managedstate", "required": false, "type": "string" } ], "related": "addCluster", "response": [ - { - "description": "comma-separated list of storage access groups for the host", - "name": "storageaccessgroups", - "type": "string" - }, - {}, { "description": "the capacity of the Cluster", "name": "capacity", "response": [ { - "description": "the total capacity available", - "name": "capacitytotal", - "type": "long" - }, - { - "description": "the Zone ID", - "name": "zoneid", - "type": "string" + "description": "the capacity type", + "name": "type", + "type": "short" }, { - "description": "the Pod ID", - "name": "podid", + "description": "the capacity name", + "name": "name", "type": "string" }, { - "description": "the Cluster ID", - "name": "clusterid", + "description": "the Cluster name", + "name": "clustername", "type": "string" }, { @@ -135180,23 +135709,18 @@ "type": "string" }, { - "description": "the capacity type", - "name": "type", - "type": "short" - }, - { - "description": "the Zone name", - "name": "zonename", + "description": "the Pod ID", + "name": "podid", "type": "string" }, { - "description": "the Cluster name", - "name": "clustername", + "description": "The tag for the capacity type", + "name": "tag", "type": "string" }, { - "description": "the capacity name", - "name": "name", + "description": "the Cluster ID", + "name": "clusterid", "type": "string" }, { @@ -135204,43 +135728,48 @@ "name": "capacityused", "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 tag for the capacity type", - "name": "tag", + "description": "the total capacity available", + "name": "capacitytotal", + "type": "long" + }, + { + "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" } ], "type": "list" }, + {}, { - "description": "the Pod name of the cluster", - "name": "podname", - "type": "string" - }, - { - "description": "the cluster ID", - "name": "id", + "description": "The ID of extension for this cluster", + "name": "extensionid", "type": "string" }, { - "description": "the Zone ID of the cluster", - "name": "zoneid", + "description": "the cluster name", + "name": "name", "type": "string" }, - {}, { - "description": "The memory overcommit ratio of the cluster", - "name": "memoryovercommitratio", + "description": "the type of the cluster", + "name": "clustertype", "type": "string" }, { @@ -135249,23 +135778,19 @@ "type": "string" }, { - "description": "the type of the cluster", - "name": "clustertype", + "description": "The name of extension for this cluster", + "name": "extensionname", "type": "string" }, + {}, { - "description": "Meta data associated with the zone (key/value pairs)", - "name": "resourcedetails", - "type": "map" - }, - { - "description": "whether this cluster is managed by cloudstack", - "name": "managedstate", + "description": "the Pod ID of the cluster", + "name": "podid", "type": "string" }, { - "description": "CPU Arch of the hosts in the cluster", - "name": "arch", + "description": "comma-separated list of storage access groups on the pod", + "name": "podstorageaccessgroups", "type": "string" }, { @@ -135274,64 +135799,79 @@ "type": "integer" }, { - "description": "the Pod ID of the cluster", - "name": "podid", + "description": "The cpu overcommit ratio of the cluster", + "name": "cpuovercommitratio", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the Zone name of the cluster", + "name": "zonename", "type": "string" }, { - "description": "The cpu overcommit ratio of the cluster", - "name": "cpuovercommitratio", + "description": "The memory overcommit ratio of the cluster", + "name": "memoryovercommitratio", "type": "string" }, { - "description": "The name of extension for this cluster", - "name": "extensionname", + "description": "Ovm3 VIP to use for pooling and/or clustering", + "name": "ovm3vip", "type": "string" }, { - "description": "comma-separated list of storage access groups on the pod", - "name": "podstorageaccessgroups", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "CPU Arch of the hosts in the cluster", + "name": "arch", "type": "string" }, { - "description": "Ovm3 VIP to use for pooling and/or clustering", - "name": "ovm3vip", + "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", "type": "string" }, { - "description": "the cluster name", - "name": "name", + "description": "the cluster ID", + "name": "id", "type": "string" }, { - "description": "the allocation state of the cluster", - "name": "allocationstate", + "description": "whether this cluster is managed by cloudstack", + "name": "managedstate", "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 Pod name of the cluster", + "name": "podname", + "type": "string" }, { "description": "comma-separated list of storage access groups on the zone", "name": "zonestorageaccessgroups", "type": "string" }, - {}, { - "description": "the Zone name of the cluster", - "name": "zonename", + "description": "the allocation state of the cluster", + "name": "allocationstate", "type": "string" }, { - "description": "The ID of extension for this cluster", - "name": "extensionid", + "description": "the Zone ID of the cluster", + "name": "zoneid", "type": "string" } ] @@ -135342,18 +135882,18 @@ "name": "listVmwareDcVms", "params": [ { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "The name/ip of vCenter. Make sure it is IP address or full qualified domain name for host running vCenter server.", + "description": "", "length": 255, - "name": "vcenter", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { "description": "", @@ -135363,19 +135903,18 @@ "type": "integer" }, { - "description": "The Username required to connect to resource.", + "description": "Name of the VM on vCenter. Must be set along with the hostname parameter", "length": 255, - "name": "username", + "name": "instancename", "required": false, "type": "string" }, { - "description": "UUID of a linked existing vCenter", + "description": "Name of the host on vCenter. Must be set along with the instancename parameter", "length": 255, - "name": "existingvcenterid", - "related": "", + "name": "hostname", "required": false, - "type": "uuid" + "type": "string" }, { "description": "The password for specified username.", @@ -135385,59 +135924,169 @@ "type": "string" }, { - "description": "Name of the host on vCenter. Must be set along with the instancename parameter", + "description": "Name of VMware datacenter.", "length": 255, - "name": "hostname", + "name": "datacentername", "required": false, "type": "string" }, { - "description": "Name of VMware datacenter.", + "description": "The Username required to connect to resource.", "length": 255, - "name": "datacentername", + "name": "username", "required": false, "type": "string" }, { - "description": "Name of the VM on vCenter. Must be set along with the hostname parameter", + "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": "instancename", + "name": "vcenter", "required": false, "type": "string" }, { - "description": "List by keyword", + "description": "UUID of a linked existing vCenter", "length": 255, - "name": "keyword", + "name": "existingvcenterid", + "related": "", "required": false, - "type": "string" + "type": "uuid" } ], "related": "listUnmanagedInstances", "response": [ { - "description": "indicates the boot mode", - "name": "bootmode", + "description": "the power state of the virtual machine", + "name": "powerstate", "type": "string" }, + {}, { - "description": "the power state of the virtual machine", - "name": "powerstate", + "description": "the operating system ID of the virtual machine", + "name": "osid", + "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 cluster to which virtual machine belongs", + "name": "clustername", "type": "string" }, + { + "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", + "type": "integer" + }, + { + "description": "the list of disks associated with the virtual machine", + "name": "disk", + "response": [ + { + "description": "the capacity of the disk in bytes", + "name": "capacity", + "type": "long" + }, + { + "description": "the controller of the disk", + "name": "datastorename", + "type": "string" + }, + { + "description": "the controller of the disk", + "name": "datastoretype", + "type": "string" + }, + { + "description": "the controller of the disk", + "name": "controller", + "type": "string" + }, + { + "description": "the controller unit of the disk", + "name": "controllerunit", + "type": "integer" + }, + { + "description": "the ID of the disk", + "name": "id", + "type": "string" + }, + { + "description": "the controller of the disk", + "name": "datastorepath", + "type": "string" + }, + { + "description": "the file path of the disk image", + "name": "imagepath", + "type": "string" + }, + { + "description": "the position of the disk", + "name": "position", + "type": "integer" + }, + { + "description": "the label of the disk", + "name": "label", + "type": "string" + }, + { + "description": "the controller of the disk", + "name": "datastorehost", + "type": "string" + } + ], + "type": "set" + }, { "description": "the CPU speed of the virtual machine", "name": "cpuspeed", "type": "integer" }, + {}, + { + "description": "the CPU cores per socket for the virtual machine. VMware specific", + "name": "cpucorepersocket", + "type": "integer" + }, + { + "description": "the memory of the virtual machine in MB", + "name": "memory", + "type": "integer" + }, + { + "description": "the name of the virtual machine", + "name": "name", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { - "description": "the operating system of the virtual machine", - "name": "osdisplayname", + "description": "indicates the boot mode", + "name": "bootmode", "type": "string" }, { - "description": "the operating system ID of the virtual machine", - "name": "osid", + "description": "indicates the boot type", + "name": "boottype", "type": "string" }, { @@ -135450,48 +136099,28 @@ "type": "string" }, { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "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": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { @@ -135500,38 +136129,33 @@ "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 netmask of the nic", - "name": "netmask", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "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 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 name of the corresponding network", - "name": "networkname", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { @@ -135540,366 +136164,121 @@ "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the ID of the nic", + "name": "id", "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", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "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", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" }, { - "description": "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": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "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", - "type": "string" + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "description": "the label of the disk", - "name": "label", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "the file path of the disk image", - "name": "imagepath", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "the capacity of the disk in bytes", - "name": "capacity", - "type": "long" - }, - { - "description": "the ID of the disk", - "name": "id", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "the position of the disk", - "name": "position", - "type": "integer" - }, - { - "description": "the controller of the disk", - "name": "datastorehost", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "the controller unit of the disk", - "name": "controllerunit", - "type": "integer" - }, - { - "description": "the controller of the disk", - "name": "datastoretype", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "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": "the ip address of the nic", + "name": "ipaddress", "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", - "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 ID of the cluster to which virtual machine belongs", + "name": "clusterid", "type": "string" }, { "description": "the name of the host to which virtual machine belongs", "name": "hostname", "type": "string" - }, - { - "description": "the CPU cores per socket for the virtual machine. VMware specific", - "name": "cpucorepersocket", - "type": "integer" - }, - { - "description": "the CPU cores of the virtual machine", - "name": "cpunumber", - "type": "integer" } ] }, - { - "description": "Update the extension", - "isasync": false, - "name": "updateExtension", - "params": [ - { - "description": "Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].endpoint.url=urlvalue", - "length": 255, - "name": "details", - "required": false, - "type": "map" - }, - { - "description": "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, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, @@ -135909,32 +136288,39 @@ "name": "type", "required": true, "type": "string" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" } ], "related": "", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the storage provider", + "name": "name", "type": "string" }, { - "description": "the name of the storage provider", - "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": "the type of the storage provider: primary or image provider", "name": "type", "type": "string" - } + }, + {} ] }, { @@ -135949,13 +136335,6 @@ "required": false, "type": "integer" }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, { "description": "", "length": 255, @@ -135970,27 +136349,34 @@ "related": "", "required": true, "type": "uuid" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" } ], "related": "", "response": [ - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "ucs profile dn", "name": "ucsdn", "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" + } ] }, { @@ -136014,16 +136400,20 @@ "name": "apikey", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the secret key of the registered user", "name": "secretkey", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, {}, { @@ -136031,11 +136421,7 @@ "name": "apikeyaccess", "type": "boolean" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } + {} ], "since": "4.10.0" }, @@ -136045,16 +136431,9 @@ "name": "updateGlobalLoadBalancerRule", "params": [ { - "description": "load balancer algorithm (roundrobin, leastconn, proximity) that is used to distributed traffic across the zones participating in global server load balancing, if not specified defaults to 'round robin'", - "length": 255, - "name": "gslblbmethod", - "required": false, - "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" }, @@ -136067,9 +136446,16 @@ "type": "uuid" }, { - "description": "the description of the load balancer rule", - "length": 4096, - "name": "description", + "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, + "name": "gslblbmethod", "required": false, "type": "string" } @@ -136077,61 +136463,36 @@ "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", + "description": "session persistence method used for the global load balancer", + "name": "gslbstickysessionmethodname", "type": "string" }, { - "description": "the project name of the load balancer", - "name": "project", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { "description": "global load balancer rule ID", "name": "id", "type": "string" }, { - "description": "name of the global load balancer rule", - "name": "name", - "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 domain ID of the load balancer rule", - "name": "domainid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, {}, { - "description": "GSLB service type", - "name": "gslbservicetype", - "type": "string" - }, - { - "description": "the domain of the load balancer rule", - "name": "domain", + "description": "the project name of the load balancer", + "name": "project", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "Region Id in which global load balancer is created", + "name": "regionid", + "type": "integer" }, { "description": "the account of the load balancer rule", @@ -136142,48 +136503,113 @@ "description": "List of load balancer rules that are part of GSLB rule", "name": "loadbalancerrule", "response": [ + { + "description": "the public ip address id", + "name": "publicipid", + "type": "string" + }, + { + "description": "the private port", + "name": "privateport", + "type": "string" + }, { "description": "path of the domain to which the load balancer rule belongs", "name": "domainpath", "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 CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,).", + "name": "cidrlist", + "type": "string" + }, + { + "description": "the id of the guest network the lb rule belongs to", + "name": "networkid", + "type": "string" + }, { "description": "the protocol of the loadbalanacer rule", "name": "protocol", "type": "string" }, + { + "description": "the domain of the load balancer rule", + "name": "domain", + "type": "string" + }, + { + "description": "the public ip address", + "name": "publicip", + "type": "string" + }, + { + "description": "the public port", + "name": "publicport", + "type": "string" + }, + { + "description": "the load balancer rule ID", + "name": "id", + "type": "string" + }, + { + "description": "the state of the rule", + "name": "state", + "type": "string" + }, + { + "description": "the description of the load balancer", + "name": "description", + "type": "string" + }, + { + "description": "the id of the zone the rule belongs to", + "name": "zoneid", + "type": "string" + }, { "description": "the list of resource tags associated with load balancer", "name": "tags", "response": [ { - "description": "tag key name", - "name": "key", + "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": "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": "the ID of the domain associated with the tag", - "name": "domainid", + "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" }, { @@ -136192,144 +136618,104 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" } ], "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", - "type": "string" - }, - { - "description": "the account of the load balancer rule", - "name": "account", - "type": "string" + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { "description": "the project id of the load balancer", "name": "projectid", "type": "string" }, - { - "description": "the domain of the load balancer rule", - "name": "domain", - "type": "string" - }, - { - "description": "the state of the rule", - "name": "state", - "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": "the project name of the load balancer", "name": "project", "type": "string" }, { - "description": "the public ip address id", - "name": "publicipid", - "type": "string" - }, - { - "description": "the public ip address", - "name": "publicip", - "type": "string" - }, - { - "description": "the private port", - "name": "privateport", + "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", + "description": "the account of the load balancer rule", + "name": "account", "type": "string" }, { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the 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" } ], "type": "list" }, + { + "description": "the description of the global load balancer rule", + "name": "description", + "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": "Region Id in which global load balancer is created", - "name": "regionid", - "type": "integer" + "description": "name of the global load balancer rule", + "name": "name", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the project id of the load balancer", + "name": "projectid", + "type": "string" }, { - "description": "session persistence method used for the global load balancer", - "name": "gslbstickysessionmethodname", + "description": "GSLB service type", + "name": "gslbservicetype", + "type": "string" + }, + { + "description": "the domain of the load balancer rule", + "name": "domain", + "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" } ] @@ -136340,25 +136726,25 @@ "name": "listHostTags", "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": "", @@ -136368,15 +136754,14 @@ "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", + "description": "the ID of the host tag", + "name": "id", "type": "string" }, { @@ -136384,17 +136769,18 @@ "name": "hostid", "type": "long" }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - { - "description": "the ID of the host tag", - "name": "id", - "type": "string" - }, - {} + } ] }, { @@ -136403,11 +136789,18 @@ "name": "addGuestOs", "params": [ { - "description": "Optional name for Guest OS", + "description": "Map of (key/value pairs)", "length": 255, - "name": "name", + "name": "details", "required": false, - "type": "string" + "type": "map" + }, + { + "description": "whether this guest OS is available for end users", + "length": 255, + "name": "forDisplay", + "required": false, + "type": "boolean" }, { "description": "Unique display name for Guest OS", @@ -136417,11 +136810,11 @@ "type": "string" }, { - "description": "Map of (key/value pairs)", + "description": "Optional name for Guest OS", "length": 255, - "name": "details", + "name": "name", "required": false, - "type": "map" + "type": "string" }, { "description": "ID of Guest OS category", @@ -136430,13 +136823,6 @@ "related": "listOsCategories", "required": true, "type": "uuid" - }, - { - "description": "whether this guest OS is available for end users", - "length": 255, - "name": "forDisplay", - "required": false, - "type": "boolean" } ], "related": "", @@ -136448,9 +136834,9 @@ "type": "string" }, { - "description": "the ID of the OS category", - "name": "oscategoryid", - "type": "string" + "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", @@ -136459,25 +136845,20 @@ }, {}, { - "description": "is the guest OS visible for the users", - "name": "fordisplay", + "description": "is the guest OS user defined", + "name": "isuserdefined", "type": "boolean" }, { - "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": "oscategoryid", + "type": "string" }, { "description": "the ID of the OS type", "name": "id", "type": "string" }, - { - "description": "is the guest OS user defined", - "name": "isuserdefined", - "type": "boolean" - }, { "description": "the name of the OS category", "name": "oscategoryname", @@ -136487,6 +136868,11 @@ "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" } ], "since": "4.4.0" @@ -136496,6 +136882,14 @@ "isasync": false, "name": "addAnnotation", "params": [ + { + "description": "the annotation is visible for admins only", + "length": 255, + "name": "adminsonly", + "required": false, + "since": "4.16.0", + "type": "boolean" + }, { "description": "the id of the entity to annotate", "length": 255, @@ -136510,14 +136904,6 @@ "required": false, "type": "string" }, - { - "description": "the annotation is visible for admins only", - "length": 255, - "name": "adminsonly", - "required": false, - "since": "4.16.0", - "type": "boolean" - }, { "description": "the annotation text", "length": 255, @@ -136528,14 +136914,15 @@ ], "related": "", "response": [ + {}, { - "description": "the (uu)id of the entity to which this annotation pertains", - "name": "entityid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The (uu)id of the user that entered the annotation", + "name": "userid", "type": "string" }, { @@ -136544,51 +136931,50 @@ "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": "True if the annotation is available for admins only", + "name": "adminsonly", + "type": "boolean" }, { - "description": "the contents of the annotation", - "name": "annotation", + "description": "The username of the user that entered the annotation", + "name": "username", "type": "string" }, { - "description": "the (uu)id of the annotation", - "name": "id", + "description": "the name of the entity to which this annotation pertains", + "name": "entityname", "type": "string" }, { - "description": "The (uu)id of the user that entered the annotation", - "name": "userid", + "description": "the type of the annotated entity", + "name": "entitytype", "type": "string" }, { - "description": "the type of the annotated entity", - "name": "entitytype", + "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 contents of the annotation", + "name": "annotation", "type": "string" }, {}, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the removal timestamp for this annotation", + "name": "removed", + "type": "date" }, { - "description": "True if the annotation is available for admins only", - "name": "adminsonly", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ], "since": "4.11" @@ -136598,6 +136984,14 @@ "isasync": true, "name": "deployNetscalerVpx", "params": [ + { + "description": "availability zone for the virtual machine", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" + }, { "description": "the ID of the service offering for the virtual machine", "length": 255, @@ -136618,15 +137012,7 @@ "description": "the ID of the template for the virtual machine", "length": 255, "name": "templateid", - "related": "listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", - "required": true, - "type": "uuid" - }, - { - "description": "availability zone for the virtual machine", - "length": 255, - "name": "zoneid", - "related": "listZones", + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", "required": true, "type": "uuid" } @@ -136634,13 +137020,13 @@ "related": "addNetscalerLoadBalancer,registerNetscalerControlCenter", "response": [ { - "description": "true if device is dedicated for an account", - "name": "lbdevicededicated", - "type": "boolean" + "description": "device capacity", + "name": "lbdevicecapacity", + "type": "long" }, { - "description": "the physical network to which this netscaler device belongs to", - "name": "physicalnetworkid", + "description": "device state", + "name": "lbdevicestate", "type": "string" }, { @@ -136648,25 +137034,37 @@ "name": "gslbprovider", "type": "boolean" }, + {}, + {}, + { + "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": "device capacity", - "name": "lbdevicecapacity", - "type": "long" + "description": "Used when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device.", + "name": "podids", + "type": "list" }, { - "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": "private IP of the NetScaler representing GSLB site", + "name": "gslbproviderprivateip", + "type": "string" }, { "description": "device id of the netscaler load balancer", @@ -136679,25 +137077,14 @@ "type": "boolean" }, { - "description": "private IP of the NetScaler representing GSLB site", - "name": "gslbproviderprivateip", - "type": "string" - }, - { - "description": "Used when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device.", - "name": "podids", - "type": "list" - }, - {}, - { - "description": "the public interface of the load balancer", - "name": "publicinterface", + "description": "device name", + "name": "lbdevicename", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "true if device is dedicated for an account", + "name": "lbdevicededicated", + "type": "boolean" }, { "description": "name of the provider", @@ -136705,16 +137092,15 @@ "type": "string" }, { - "description": "device name", - "name": "lbdevicename", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "device state", - "name": "lbdevicestate", + "description": "the private interface of the load balancer", + "name": "privateinterface", "type": "string" }, - {}, { "description": "the management IP address of the external load balancer", "name": "ipaddress", @@ -136742,42 +137128,42 @@ "name": "jobstatus", "type": "integer" }, - {}, { - "description": "compression", - "name": "compression", + "description": "the name of the volume", + "name": "name", "type": "string" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - { - "description": "graceallowed", - "name": "graceallowed", - "type": "string" - }, { "description": "deduplication", "name": "deduplication", "type": "string" }, { - "description": "the name of the volume", - "name": "name", + "description": "compression", + "name": "compression", "type": "string" }, + {}, { "description": "the id of the volume", "name": "id", "type": "string" }, - {}, { "description": "synchronization", "name": "sync", "type": "string" + }, + { + "description": "graceallowed", + "name": "graceallowed", + "type": "string" } ] }, @@ -136787,16 +137173,17 @@ "name": "addBaremetalPxeKickStartServer", "params": [ { - "description": "URL of the external pxe device", + "description": "Pod Id", "length": 255, - "name": "url", - "required": true, - "type": "string" + "name": "podid", + "related": "createManagementNetworkIpRange", + "required": false, + "type": "uuid" }, { - "description": "type of pxe device", + "description": "Tftp root directory of PXE server", "length": 255, - "name": "pxeservertype", + "name": "tftpdir", "required": true, "type": "string" }, @@ -136809,46 +137196,49 @@ "type": "uuid" }, { - "description": "Pod Id", + "description": "type of pxe device", "length": 255, - "name": "podid", - "related": "createManagementNetworkIpRange", - "required": false, - "type": "uuid" + "name": "pxeservertype", + "required": true, + "type": "string" }, { "description": "Credentials to reach external pxe device", "length": 255, - "name": "username", + "name": "password", "required": true, "type": "string" }, { - "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": "Credentials to reach external pxe device", + "description": "URL of the external pxe device", "length": 255, - "name": "password", + "name": "url", "required": true, "type": "string" } ], "related": "", "response": [ + { + "description": "device id of ", + "name": "id", + "type": "string" + }, { "description": "url", "name": "url", "type": "string" }, - {}, { - "description": "device id of ", - "name": "id", + "description": "Tftp root directory of PXE server", + "name": "tftpdir", "type": "string" }, { @@ -136856,9 +137246,10 @@ "name": "physicalnetworkid", "type": "string" }, + {}, { - "description": "Tftp root directory of PXE server", - "name": "tftpdir", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -136866,17 +137257,12 @@ "name": "provider", "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" - }, - {} + } ] }, { @@ -136884,13 +137270,6 @@ "isasync": false, "name": "listNiciraNvpDevices", "params": [ - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, { "description": "List by keyword", "length": 255, @@ -136920,20 +137299,18 @@ "related": "addNiciraNvpDevice,listNiciraNvpDevices", "required": false, "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" } ], "related": "addNiciraNvpDevice", "response": [ - { - "description": "this L2 gateway service Uuid", - "name": "l2gatewayserviceuuid", - "type": "string" - }, - { - "description": "the physical network to which this Nirica Nvp belongs to", - "name": "physicalnetworkid", - "type": "string" - }, + {}, { "description": "device name", "name": "niciradevicename", @@ -136945,36 +137322,45 @@ "type": "string" }, { - "description": "the transport zone Uuid", - "name": "transportzoneuuid", + "description": "the controller Ip address", + "name": "hostname", "type": "string" }, {}, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "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": "the physical network to which this Nirica Nvp belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "this L3 gateway service Uuid", - "name": "l3gatewayserviceuuid", + "description": "this L2 gateway service Uuid", + "name": "l2gatewayserviceuuid", "type": "string" }, { - "description": "the controller Ip address", - "name": "hostname", + "description": "device id of the Nicire Nvp", + "name": "nvpdeviceid", "type": "string" + }, + { + "description": "the transport zone Uuid", + "name": "transportzoneuuid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -136984,26 +137370,25 @@ "name": "listAlerts", "params": [ { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "list by alert name", + "description": "List by keyword", "length": 255, - "name": "name", + "name": "keyword", "required": false, - "since": "4.3", "type": "string" }, { - "description": "", + "description": "list by alert type", "length": 255, - "name": "pagesize", + "name": "type", "required": false, - "type": "integer" + "type": "string" }, { "description": "the ID of the alert", @@ -137014,48 +137399,44 @@ "type": "uuid" }, { - "description": "", + "description": "list by alert name", "length": 255, - "name": "page", + "name": "name", "required": false, - "type": "integer" + "since": "4.3", + "type": "string" }, { - "description": "list by alert type", + "description": "", "length": 255, - "name": "type", + "name": "page", "required": false, - "type": "string" + "type": "integer" } ], "related": "", "response": [ + { + "description": "the id of the alert", + "name": "id", + "type": "string" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "description of the alert", - "name": "description", - "type": "string" + "description": "One of the following alert types: MEMORY = 0, CPU = 1, STORAGE = 2, STORAGE_ALLOCATED = 3, PUBLIC_IP = 4, PRIVATE_IP = 5, SECONDARY_STORAGE = 6, HOST = 7, USERVM = 8, DOMAIN_ROUTER = 9, CONSOLE_PROXY = 10, ROUTING = 11: lost connection to default route (to the gateway), STORAGE_MISC = 12, USAGE_SERVER = 13, MANAGMENT_NODE = 14, DOMAIN_ROUTER_MIGRATE = 15, CONSOLE_PROXY_MIGRATE = 16, USERVM_MIGRATE = 17, VLAN = 18, SSVM = 19, USAGE_SERVER_RESULT = 20, STORAGE_DELETE = 21, UPDATE_RESOURCE_COUNT = 22, USAGE_SANITY_RESULT = 23, DIRECT_ATTACHED_PUBLIC_IP = 24, LOCAL_STORAGE = 25, RESOURCE_LIMIT_EXCEEDED = 26, SYNC = 27, UPLOAD_FAILED = 28, OOBM_AUTH_ERROR = 29", + "name": "type", + "type": "short" }, { "description": "the date and time the alert was sent", "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", @@ -137063,9 +137444,14 @@ "type": "integer" }, { - "description": "One of the following alert types: MEMORY = 0, CPU = 1, STORAGE = 2, STORAGE_ALLOCATED = 3, PUBLIC_IP = 4, PRIVATE_IP = 5, SECONDARY_STORAGE = 6, HOST = 7, USERVM = 8, DOMAIN_ROUTER = 9, CONSOLE_PROXY = 10, ROUTING = 11: lost connection to default route (to the gateway), STORAGE_MISC = 12, USAGE_SERVER = 13, MANAGMENT_NODE = 14, DOMAIN_ROUTER_MIGRATE = 15, CONSOLE_PROXY_MIGRATE = 16, USERVM_MIGRATE = 17, VLAN = 18, SSVM = 19, USAGE_SERVER_RESULT = 20, STORAGE_DELETE = 21, UPDATE_RESOURCE_COUNT = 22, USAGE_SANITY_RESULT = 23, DIRECT_ATTACHED_PUBLIC_IP = 24, LOCAL_STORAGE = 25, RESOURCE_LIMIT_EXCEEDED = 26, SYNC = 27, UPLOAD_FAILED = 28, OOBM_AUTH_ERROR = 29", - "name": "type", - "type": "short" + "description": "the name of the alert", + "name": "name", + "type": "string" + }, + { + "description": "description of the alert", + "name": "description", + "type": "string" } ] }, @@ -137075,36 +137461,28 @@ "name": "deployVirtualMachine", "params": [ { - "description": "Boot into hardware setup or not (ignored if startVm = false, only valid for vmware)", + "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": "bootintosetup", + "name": "affinitygroupnames", + "related": "", "required": false, - "since": "4.15.0.0", - "type": "boolean" + "type": "list" }, { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "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": "customid", + "name": "boottype", "required": false, + "since": "4.14.0.0", "type": "string" }, { - "description": "the ID of the Userdata", + "description": "The number of queues for multiqueue NICs.", "length": 255, - "name": "userdataid", - "related": "", + "name": "nicmultiqueuenumber", "required": false, "since": "4.18", - "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" + "type": "integer" }, { "description": "host name for the virtual machine", @@ -137114,179 +137492,195 @@ "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": "name of the ssh key pair used to login to the virtual machine", "length": 255, - "name": "dhcpoptionsnetworklist", + "name": "keypair", "required": false, - "type": "map" + "type": "string" }, { - "description": "Number of days instance is leased for.", + "description": "destination Pod ID to deploy the VM to - parameter available for root admin only", "length": 255, - "name": "leaseduration", + "name": "podid", + "related": "createManagementNetworkIpRange", "required": false, - "since": "4.21.0", - "type": "integer" + "since": "4.13", + "type": "uuid" }, { - "description": "the ipv6 address for default vm's network", + "description": "true if virtual machine needs to be dynamically scalable", "length": 255, - "name": "ip6address", + "name": "dynamicscalingenabled", "required": false, - "type": "string" + "since": "4.16", + "type": "boolean" }, { - "description": "", + "description": "the ID of the template for the virtual machine", "length": 255, - "name": "volumeid", - "related": "createVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "name": "templateid", + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", "required": false, - "since": "4.21", "type": "uuid" }, { - "description": "Lease expiry action, valid values are STOP and DESTROY", + "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": "leaseexpiryaction", + "name": "dhcpoptionsnetworklist", "required": false, - "since": "4.21.0", - "type": "string" + "type": "map" }, { - "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": "Boot into hardware setup or not (ignored if startVm = false, only valid for vmware)", "length": 255, - "name": "overridediskofferingid", - "related": "", + "name": "bootintosetup", "required": false, - "since": "4.17", - "type": "uuid" + "since": "4.15.0.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", + "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": "Deploy vm for the project", + "description": "an optional user generated name for the virtual machine", "length": 255, - "name": "projectid", - "related": "", + "name": "displayname", "required": false, - "type": "uuid" + "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.", + "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": "iothreadsenabled", + "name": "datadisksdetails", "required": false, - "type": "boolean" + "since": "4.21.0", + "type": "map" }, { - "description": "an optional account for the virtual machine. Must be used with domainId.", + "description": "availability zone for the virtual machine", "length": 255, - "name": "account", - "required": false, - "type": "string" + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" }, { - "description": "list of network ids used by virtual machine. Can't be specified with ipToNetworkList parameter", + "description": "Enable packed virtqueues or not.", "length": 255, - "name": "networkids", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork", + "name": "nicpackedvirtqueuesenabled", "required": false, - "type": "list" + "since": "4.18", + "type": "boolean" }, { - "description": "an optional group 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": "group", + "name": "hypervisor", "required": false, "type": "string" }, { - "description": "an optional user generated name for the virtual machine", + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "displayname", + "name": "customid", "required": false, "type": "string" }, { - "description": "the ID of the disk offering for the virtual machine. If the template is of ISO format, the diskOfferingId is for the root disk volume. Otherwise this parameter is used to indicate the offering for the data disk volume. If the templateId parameter passed is from a Template object, the diskOfferingId refers to a DATA Disk Volume created. If the templateId parameter passed is from an ISO object, the diskOfferingId refers to a ROOT Disk Volume created.", + "description": "comma separated list of security groups 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": "diskofferingid", + "name": "securitygroupids", "related": "", "required": false, - "type": "uuid" + "type": "list" }, { - "description": "Controls specific policies on IO", + "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": "iodriverpolicy", + "name": "iothreadsenabled", "required": false, - "type": "string" + "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", + "description": "used to specify the vApp properties.", "length": 255, - "name": "securitygroupnames", - "related": "", + "name": "properties", "required": false, - "type": "list" + "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": "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": "keyboard", + "name": "nicnetworklist", + "required": false, + "since": "4.15", + "type": "map" + }, + { + "description": "an optional binary data that can be sent to the virtual machine upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST (via POST body), you can send up to 1MB of data after base64 encoding. You also need to change vm.userdata.max.length value", + "length": 1048576, + "name": "userdata", "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 ipv6 address for default vm's network", "length": 255, - "name": "securitygroupids", - "related": "", + "name": "ip6address", "required": false, - "type": "list" + "type": "string" }, { - "description": "Details in key/value pairs using format externaldetails[i].keyname=keyvalue. Example: externaldetails[0].server.type=typevalue", + "description": "an optional group for the virtual machine", "length": 255, - "name": "externaldetails", + "name": "group", "required": false, - "since": "4.21.0", - "type": "map" + "type": "string" }, { - "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 field, whether to the display the vm to the end user or not.", "length": 255, - "name": "affinitygroupids", - "related": "", + "name": "displayvm", "required": false, - "type": "list" + "since": "4.2", + "type": "boolean" }, { - "description": "the arbitrary size for the DATADISK volume. Mutually exclusive with diskOfferingId", + "description": "destination Host ID to deploy the VM to - parameter available for root admin only", "length": 255, - "name": "size", + "name": "hostid", + "related": "declareHostAsDegraded,reconnectHost", "required": false, - "type": "long" + "type": "uuid" }, { - "description": "names of the ssh key pairs used to login to the virtual machine", + "description": "if true the image tags (if any) will be copied to the VM, default value is false", "length": 255, - "name": "keypairs", + "name": "copyimagetags", "required": false, - "since": "4.17", - "type": "list" + "since": "4.13", + "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": "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": "datadisksdetails", + "name": "datadiskofferinglist", "required": false, - "since": "4.21.0", + "since": "4.11", + "type": "map" + }, + { + "description": "used to specify the parameters values for the variables in userdata.", + "length": 255, + "name": "userdatadetails", + "required": false, + "since": "4.18", "type": "map" }, { @@ -137299,33 +137693,28 @@ "type": "uuid" }, { - "description": "an optional field, whether to the display the vm to the end user or not.", - "length": 255, - "name": "displayvm", - "required": false, - "since": "4.2", - "type": "boolean" - }, - { - "description": "the mac address for default vm's network", + "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": "macaddress", + "name": "bootmode", "required": false, + "since": "4.14.0.0", "type": "string" }, { - "description": "ip to network mapping. Can't be specified with networkIds parameter. Example: iptonetworklist[0].ip=10.10.10.11&iptonetworklist[0].ipv6=fc00:1234:5678::abcd&iptonetworklist[0].networkid=uuid&iptonetworklist[0].mac=aa:bb:cc:dd:ee::ff - requests to use ip 10.10.10.11 in network id=uuid", + "description": "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": "iptonetworklist", + "name": "affinitygroupids", + "related": "", "required": false, - "type": "map" + "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": "Deploy vm for the project", "length": 255, - "name": "hypervisor", + "name": "projectid", + "related": "", "required": false, - "type": "string" + "type": "uuid" }, { "description": "used to specify the custom parameters. 'extraconfig' is not allowed to be passed in details", @@ -137336,116 +137725,115 @@ "type": "map" }, { - "description": "destination Pod ID to deploy the VM to - parameter available for root admin only", - "length": 255, - "name": "podid", - "related": "createManagementNetworkIpRange", - "required": false, - "since": "4.13", - "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": "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", + "name": "securitygroupnames", "related": "", "required": false, "type": "list" }, { - "description": "name of the ssh key pair used to login to the virtual machine", + "description": "the ID of the service offering for the virtual machine", "length": 255, - "name": "keypair", - "required": false, - "type": "string" + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", + "required": true, + "type": "uuid" }, { "description": "", "length": 255, - "name": "snapshotid", - "related": "copySnapshot,listSnapshots", + "name": "volumeid", + "related": "createVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "required": false, "since": "4.21", "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": "Details in key/value pairs using format externaldetails[i].keyname=keyvalue. Example: externaldetails[0].server.type=typevalue", "length": 255, - "name": "bootmode", + "name": "externaldetails", "required": false, - "since": "4.14.0.0", - "type": "string" + "since": "4.21.0", + "type": "map" }, { - "description": "true if virtual machine needs to be dynamically scalable", + "description": "Number of days instance is leased for.", "length": 255, - "name": "dynamicscalingenabled", + "name": "leaseduration", "required": false, - "since": "4.16", - "type": "boolean" + "since": "4.21.0", + "type": "integer" }, { - "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": "an optional account for the virtual machine. Must be used with domainId.", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "VMware only: used to specify network mapping of a vApp VMware template registered \"as-is\". Example nicnetworklist[0].ip=Nic-101&nicnetworklist[0].network=uuid", + "description": "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": "nicnetworklist", + "name": "rootdisksize", "required": false, - "since": "4.15", - "type": "map" + "since": "4.4", + "type": "long" }, { - "description": "availability zone for the virtual machine", + "description": "the ID of the Userdata", "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, + "name": "userdataid", + "related": "", + "required": false, + "since": "4.18", "type": "uuid" }, { - "description": "an optional URL encoded string that can be passed to the virtual machine upon successful deployment", - "length": 5120, - "name": "extraconfig", + "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.12", + "since": "4.19.0.0", "type": "string" }, { - "description": "used to specify the parameters values for the variables in userdata.", + "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": "userdatadetails", + "name": "domainid", + "related": "listDomains", "required": false, - "since": "4.18", - "type": "map" + "type": "uuid" }, { - "description": "the ID of the service offering for the virtual machine", + "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": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", - "required": true, + "name": "diskofferingid", + "related": "", + "required": false, "type": "uuid" }, { - "description": "The number of queues for multiqueue NICs.", + "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": "nicmultiqueuenumber", + "name": "overridediskofferingid", + "related": "", "required": false, - "since": "4.18", - "type": "integer" + "since": "4.17", + "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.", + "description": "true if start vm after creating; defaulted to true if not specified", "length": 255, - "name": "boottype", + "name": "startvm", + "required": false, + "type": "boolean" + }, + { + "description": "Controls specific policies on IO", + "length": 255, + "name": "iodriverpolicy", "required": false, - "since": "4.14.0.0", "type": "string" }, { @@ -137457,101 +137845,89 @@ "type": "string" }, { - "description": "the ip address for default vm's network", + "description": "", "length": 255, - "name": "ipaddress", + "name": "snapshotid", + "related": "copySnapshot,listSnapshots", "required": false, - "type": "string" + "since": "4.21", + "type": "uuid" }, { - "description": "Enable packed virtqueues or not.", + "description": "the mac address for default vm's network", "length": 255, - "name": "nicpackedvirtqueuesenabled", + "name": "macaddress", "required": false, - "since": "4.18", - "type": "boolean" + "type": "string" }, { - "description": "the ID of the template for the virtual machine", + "description": "Lease expiry action, valid values are STOP and DESTROY", "length": 255, - "name": "templateid", - "related": "listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "name": "leaseexpiryaction", "required": false, - "type": "uuid" + "since": "4.21.0", + "type": "string" }, { - "description": "used to specify the vApp properties.", + "description": "the arbitrary size for the DATADISK volume. Mutually exclusive with diskOfferingId", "length": 255, - "name": "properties", + "name": "size", "required": false, - "since": "4.15", - "type": "map" + "type": "long" }, { - "description": "if true the image tags (if any) will be copied to the VM, default value is false", + "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": "copyimagetags", + "name": "keyboard", "required": false, - "since": "4.13", - "type": "boolean" + "type": "string" }, { - "description": "The password of the virtual machine. If null, a random password will be generated for the VM.", + "description": "list of network ids used by virtual machine. Can't be specified with ipToNetworkList parameter", "length": 255, - "name": "password", + "name": "networkids", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork", "required": false, - "since": "4.19.0.0", - "type": "string" + "type": "list" }, { - "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 ip address for default vm's network", "length": 255, - "name": "datadiskofferinglist", + "name": "ipaddress", "required": false, - "since": "4.11", - "type": "map" + "type": "string" }, { - "description": "destination Host ID to deploy the VM to - parameter available for root admin only", + "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": "hostid", - "related": "declareHostAsDegraded,reconnectHost", + "name": "iptonetworklist", "required": false, - "type": "uuid" + "type": "map" }, { - "description": "true if start vm after creating; defaulted to true if not specified", + "description": "names of the ssh key pairs used to login to the virtual machine", "length": 255, - "name": "startvm", + "name": "keypairs", "required": false, - "type": "boolean" + "since": "4.17", + "type": "list" } ], - "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,createVMFromBackup,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "response": [ { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "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", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" - }, - { - "description": "CPU arch of the VM", - "name": "arch", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { @@ -137560,38 +137936,18 @@ "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" - }, - { - "description": "the name of userdata used for the VM", - "name": "userdataname", - "type": "string" - }, - { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" - }, - { - "description": "the name of the gpu card to which service offering is linked", - "name": "gpucardname", - "type": "string" - }, - { - "description": "device ID of the root volume", - "name": "rootdeviceid", + "description": "the maximum number of display heads", + "name": "maxheads", "type": "long" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { @@ -137600,58 +137956,48 @@ "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", - "type": "string" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", + "description": "the speed of each vCPU", + "name": "cpuspeed", "type": "integer" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" + "description": "Instance lease duration in days", + "name": "leaseduration", + "type": "integer" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "the name of the template for the virtual machine", + "name": "templatename", "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 name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "the maximum number of display heads", - "name": "maxheads", - "type": "long" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", - "type": "string" + "description": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { @@ -137660,130 +138006,329 @@ "type": "string" }, { - "description": "the format of the template for the virtual machine", - "name": "templateformat", - "type": "string" + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, - {}, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "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 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": "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" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the 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" + } + ], + "type": "set" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the 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": "true if vm has delete protection.", - "name": "deleteprotection", + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", "type": "boolean" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" - }, - { - "description": "the ID of the virtual machine", - "name": "id", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "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", + "type": "boolean" }, { - "description": "the project name of the vm", - "name": "project", + "description": "OS name of the vm", + "name": "osdisplayname", "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": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", + "type": "string" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" + "description": "the password (if exists) of the virtual machine", + "name": "password", + "type": "string" }, { - "description": "the maximum X resolution", - "name": "maxresolutionx", - "type": "long" + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "the format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "CPU arch of the VM", + "name": "arch", "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", - "type": "string" + "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", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", - "type": "string" + "description": "the list of nics associated with vm", + "name": "nic", + "response": [ + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "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", + "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 ID of the nic", + "name": "id", + "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 isolation uri of the nic", + "name": "isolationuri", + "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": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "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": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "the 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": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + } + ], + "type": "set" }, { "description": "public IP address id associated with vm via Static nat rule", @@ -137791,28 +138336,13 @@ "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": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" - }, - { - "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": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { @@ -137820,80 +138350,8 @@ "name": "securitygroup", "response": [ { - "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", - "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": "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": "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", + "description": "path of the Domain the security group belongs to", + "name": "domainpath", "type": "string" }, { @@ -137901,18 +138359,13 @@ "name": "egressrule", "response": [ { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", + "description": "the starting IP of the security group rule", + "name": "startport", "type": "integer" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { @@ -137920,43 +138373,43 @@ "name": "tags", "response": [ { - "description": "resource type", - "name": "resourcetype", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project name where tag belongs to", + "name": "project", "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": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the 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": "tag value", + "name": "value", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -137965,27 +138418,27 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" } ], "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 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", @@ -137998,31 +138451,51 @@ "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": "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" } ], "type": "set" }, + { + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "the 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", + "description": "the description of the security group", + "name": "description", "type": "string" }, { - "description": "the domain name of the security group", - "name": "domain", + "description": "the project name of the group", + "name": "project", "type": "string" }, { @@ -138034,261 +138507,260 @@ "description": "the list of ingress rules associated with the security group", "name": "ingressrule", "response": [ + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the 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 starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "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 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" }, { - "description": "tag value", - "name": "value", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the 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": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the 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" } ], "type": "set" + } + ], + "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 list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" + "description": "customer associated with the tag", + "name": "customer", + "type": "string" }, { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" }, { - "description": "account owning the security group rule", + "description": "resource type", + "name": "resourcetype", + "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 CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "security group name", - "name": "securitygroupname", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "the project id the tag belongs to", + "name": "projectid", "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" } ], "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 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 memory used by the VM in KiB", - "name": "memorykbs", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", + "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", + "description": "the count of GPUs on the virtual machine", + "name": "gpucount", "type": "integer" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" + "description": "the user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" }, { - "description": "Instance lease expiry date", - "name": "leaseexpirydate", - "type": "date" + "description": "the account associated with the virtual machine", + "name": "account", + "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", "type": "long" }, { - "description": "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 user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" }, { - "description": "User VM type", - "name": "vmtype", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", - "type": "string" + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { "description": "the outgoing network traffic on the host in KiB", @@ -138296,150 +138768,135 @@ "type": "long" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "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": "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 video RAM size in MB", - "name": "videoram", + "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": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" - }, { "description": "an alternate display text of the ISO attached to the virtual machine", "name": "isodisplaytext", "type": "string" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", - "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 date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" - }, - { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", - "type": "string" + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, { - "description": "the list of resource tags associated", - "name": "tags", + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", "response": [ { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { - "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": "tag value", - "name": "value", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "the account associated with the tag", + "description": "the account owning the affinity group", "name": "account", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + }, + { + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the type of the affinity group", + "name": "type", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", "type": "string" } ], "type": "set" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "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 control state of the host for the virtual machine", - "name": "hostcontrolstate", - "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 userdata used for the VM", - "name": "userdataid", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, + { + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" + }, + { + "description": "User VM type", + "name": "vmtype", "type": "string" }, { @@ -138447,182 +138904,61 @@ "name": "maxresolutiony", "type": "long" }, + {}, { - "description": "the list of nics associated with vm", - "name": "nic", - "response": [ - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - } - ], - "type": "set" + "description": "the project id of the vm", + "name": "projectid", + "type": "string" + }, + { + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" + }, + { + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" + }, + { + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", + "type": "string" }, {}, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the maximum X resolution", + "name": "maxresolutionx", + "type": "long" + }, + { + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, + { + "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 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" }, { - "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" }, { @@ -138630,44 +138966,94 @@ "name": "displayname", "type": "string" }, + { + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" + }, + { + "description": "the name of userdata used for the VM", + "name": "userdataname", + "type": "string" + }, + { + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" + }, + { + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" + }, + { + "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 write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" + }, { "description": "the VM's primary IP address", "name": "ipaddress", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "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 hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "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", + "description": "OS type id of the vm", + "name": "ostypeid", "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 memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, + { + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "the ID of the gpu card to which service offering is linked", - "name": "gpucardid", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" + }, + { + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { @@ -138676,8 +139062,8 @@ "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { @@ -138693,160 +139079,143 @@ "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", - "length": 255, - "name": "clusterid", - "related": "addCluster", - "required": false, - "type": "uuid" - }, - { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "isrecursive", + "name": "tags", "required": false, - "type": "boolean" + "type": "map" }, { - "description": "list volumes by disk offering of a service offering. If both service offering and disk offering are passed, service offering is ignored", + "description": "the ID of the storage pool, available to ROOT admin only", "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", "required": false, - "since": "4.19.1", - "type": "uuid" + "since": "4.3", + "type": "string" }, { - "description": "list volumes on specified host", + "description": "the pod id the disk volume belongs to", "length": 255, - "name": "hostid", - "related": "declareHostAsDegraded,reconnectHost", + "name": "podid", + "related": "createManagementNetworkIpRange", "required": false, "type": "uuid" }, { - "description": "", + "description": "the name of the disk volume", "length": 255, - "name": "pagesize", + "name": "name", "required": false, - "type": "integer" + "type": "string" }, { - "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": "the ID of the virtual machine", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "virtualmachineid", + "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,createVMFromBackup,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "required": false, "type": "uuid" }, { - "description": "list only volumes that are encrypted", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "isencrypted", + "name": "displayvolume", "required": false, - "since": "4.19.1", + "since": "4.4", "type": "boolean" }, { - "description": "the ID of the virtual machine", + "description": "", "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": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "list volumes by disk offering", + "description": "list volumes on specified host", "length": 255, - "name": "diskofferingid", - "related": "", + "name": "hostid", + "related": "declareHostAsDegraded,reconnectHost", "required": false, - "since": "4.4", "type": "uuid" }, { - "description": "state of the volume. Possible values are: Ready, Allocated, Destroy, Expunging, Expunged.", + "description": "the type of disk volume", "length": 255, - "name": "state", + "name": "type", "required": false, "type": "string" }, { - "description": "the IDs of the volumes, mutually exclusive with id", + "description": "the cluster id the disk volume belongs to", "length": 255, - "name": "ids", - "related": "createVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "name": "clusterid", + "related": "addCluster", "required": false, - "since": "4.9", - "type": "list" + "type": "uuid" }, { - "description": "", + "description": "the ID of the availability zone", "length": 255, - "name": "page", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "the name of the disk volume", + "description": "List by keyword", "length": 255, - "name": "name", + "name": "keyword", "required": false, "type": "string" }, { - "description": "List by keyword", + "description": "list volumes by disk offering", "length": 255, - "name": "keyword", + "name": "diskofferingid", + "related": "", "required": false, - "type": "string" + "since": "4.4", + "type": "uuid" }, { - "description": "the pod id the disk volume belongs to", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "podid", - "related": "createManagementNetworkIpRange", + "name": "projectid", + "related": "", "required": false, "type": "uuid" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "list only volumes that are encrypted", "length": 255, - "name": "displayvolume", + "name": "isencrypted", "required": false, - "since": "4.4", + "since": "4.19.1", "type": "boolean" }, { - "description": "the ID of the storage pool, available to ROOT admin only", + "description": "state of the volume. Possible values are: Ready, Allocated, Destroy, Expunging, Expunged.", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", + "name": "state", "required": false, - "since": "4.3", "type": "string" }, { - "description": "the type of disk volume", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "type", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "string" + "type": "uuid" }, { "description": "the ID of the disk volume", @@ -138857,264 +139226,257 @@ "type": "uuid" }, { - "description": "list only resources belonging to the domain specified", + "description": "list system VMs; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "listsystemvms", "required": false, - "type": "uuid" + "since": "4.18", + "type": "boolean" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "account", + "name": "isrecursive", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "List resources by tags (key/value pairs)", + "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": "tags", + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", "required": false, - "type": "map" + "since": "4.19.1", + "type": "uuid" }, { - "description": "makes the API's response contains only the resource count", + "description": "the IDs of the volumes, mutually exclusive with id", "length": 255, - "name": "retrieveonlyresourcecount", + "name": "ids", + "related": "createVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "required": false, - "type": "boolean" + "since": "4.9", + "type": "list" }, { - "description": "list system VMs; only ROOT admin is eligible to pass this parameter", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "listsystemvms", + "name": "listall", "required": false, - "since": "4.18", "type": "boolean" - } - ], - "related": "createVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", - "response": [ - { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", - "type": "long" }, { - "description": "pod id of the volume", - "name": "podid", + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "name of the virtual machine", - "name": "vmname", - "type": "string" - }, + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + } + ], + "related": "createVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "response": [ { "description": "name of the disk offering", "name": "diskofferingname", "type": "string" }, { - "description": "the format of the disk encryption if applicable", - "name": "encryptformat", + "description": "name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" }, { - "description": "the path of the volume", - "name": "path", + "description": "the disk utilization", + "name": "utilization", "type": "string" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", + "description": "size of the disk volume", + "name": "size", "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": "cluster name where the volume is allocated", + "name": "clustername", "type": "string" }, + {}, { "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": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", "type": "long" }, { - "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": "state of the virtual machine", - "name": "vmstate", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" }, { - "description": "ID of the disk volume", - "name": "id", + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "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 id of the vpn", - "name": "projectid", + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": "the state of the disk volume", + "name": "state", "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 boolean state of whether the volume is destroyed or not", - "name": "destroyed", - "type": "boolean" + "description": "ID of the availability zone", + "name": "zoneid", + "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, { - "description": "the bytes actually consumed on disk", - "name": "physicalsize", - "type": "long" + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", + "type": "string" }, { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", "type": "string" }, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", - "type": "string" + "description": "min iops of the disk volume", + "name": "miniops", + "type": "long" }, + {}, { - "description": "true if volume has delete protection.", - "name": "deleteprotection", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "id of the virtual machine", + "name": "virtualmachineid", "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": "Hypervisor the volume belongs to", - "name": "hypervisor", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "cluster id of the volume", - "name": "clusterid", + "description": "state of the virtual machine", + "name": "vmstate", "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": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" + "description": "display name of the virtual machine", + "name": "vmdisplayname", + "type": "string" }, { - "description": "the bytes allocated", - "name": "virtualsize", + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", "type": "long" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" - }, - { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", + "description": "cluster id of the volume", + "name": "clusterid", "type": "string" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "name of the virtual machine", + "name": "vmname", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", + "type": "string" }, - {}, { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", - "type": "long" + "description": "details for the volume repair result, they may vary for different hypervisors", + "name": "volumerepairresult", + "type": "map" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "description": "the path of the volume", + "name": "path", "type": "string" }, { - "description": "the account associated with the disk volume", - "name": "account", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { @@ -139123,64 +139485,48 @@ "type": "string" }, { - "description": "max iops of the disk volume", - "name": "maxiops", - "type": "long" - }, - { - "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": "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": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", + "type": "string" }, { - "description": "ID of the availability zone", - "name": "zoneid", + "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": "pod id of the volume", + "name": "podid", + "type": "string" }, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", + "description": "pod name of the volume", + "name": "podname", "type": "string" }, { - "description": "shared or local storage", - "name": "storagetype", + "description": "the chain info of the volume", + "name": "chaininfo", "type": "string" }, - {}, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": "pod name of the volume", - "name": "podname", - "type": "string" + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" }, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", + "description": "the read (IO) of disk on the vm", + "name": "diskioread", "type": "long" }, { @@ -139189,67 +139535,62 @@ "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", + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, { - "description": "the chain info of the volume", - "name": "chaininfo", - "type": "string" + "description": "max iops of the disk volume", + "name": "maxiops", + "type": "long" }, { - "description": "the disk utilization", - "name": "utilization", - "type": "string" + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", + "type": "long" }, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "shared or local storage", + "name": "storagetype", "type": "string" }, { - "description": "the status of the volume", - "name": "status", - "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": "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": "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": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -139258,67 +139599,112 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "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" } ], "type": "set" }, { - "description": "details for the volume repair result, they may vary for different hypervisors", - "name": "volumerepairresult", - "type": "map" + "description": "type of the virtual machine", + "name": "vmtype", + "type": "string" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "type": "long" + }, + { + "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 bytes allocated", + "name": "virtualsize", + "type": "long" + }, + { + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", "type": "boolean" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", "type": "string" }, { - "description": "type of the virtual machine", - "name": "vmtype", + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "name of the disk volume", + "name": "name", "type": "string" }, { - "description": "size of the disk volume", - "name": "size", + "description": "name of the availability zone", + "name": "zonename", + "type": "string" + }, + { + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", "type": "long" }, { - "description": "the state of the disk volume", - "name": "state", + "description": "true if volume has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + { + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" + }, + { + "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": "the bytes actually consumed on disk", + "name": "physicalsize", + "type": "long" } ] }, @@ -139337,11 +139723,6 @@ } ], "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", @@ -139352,12 +139733,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" + }, {} ] }, @@ -139366,14 +139752,6 @@ "isasync": true, "name": "createLBHealthCheckPolicy", "params": [ - { - "description": "an optional field, whether to the display the rule to the end user or not", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" - }, { "description": "Number of consecutive health check failures before declaring an instance unhealthy", "length": 255, @@ -139382,19 +139760,11 @@ "type": "integer" }, { - "description": "Amount of time between health checks (1 sec - 20940 sec)", + "description": "the description of the load balancer health check policy", "length": 255, - "name": "intervaltime", + "name": "description", "required": false, - "type": "integer" - }, - { - "description": "the ID of the load balancer rule", - "length": 255, - "name": "lbruleid", - "related": "", - "required": true, - "type": "uuid" + "type": "string" }, { "description": "Time to wait when receiving a response from the health check (2sec - 60 sec)", @@ -139404,18 +139774,19 @@ "type": "integer" }, { - "description": "the description of the load balancer health check policy", + "description": "Number of consecutive health check success before declaring an instance healthy", "length": 255, - "name": "description", + "name": "healthythreshold", "required": false, - "type": "string" + "type": "integer" }, { - "description": "Number of consecutive health check success before declaring an instance healthy", + "description": "an optional field, whether to the display the rule to the end user or not", "length": 255, - "name": "healthythreshold", + "name": "fordisplay", "required": false, - "type": "integer" + "since": "4.4", + "type": "boolean" }, { "description": "HTTP ping path", @@ -139423,65 +139794,53 @@ "name": "pingpath", "required": false, "type": "string" - } - ], - "related": "", - "response": [ - { - "description": "the LB rule ID", - "name": "lbruleid", - "type": "string" }, { - "description": "the account of the HealthCheck policy", - "name": "account", - "type": "string" + "description": "the ID of the load balancer rule", + "length": 255, + "name": "lbruleid", + "related": "", + "required": true, + "type": "uuid" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "Amount of time between health checks (1 sec - 20940 sec)", + "length": 255, + "name": "intervaltime", + "required": false, "type": "integer" - }, - {}, + } + ], + "related": "", + "response": [ { "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", - "type": "string" - }, { "description": "the list of healthcheckpolicies", "name": "healthcheckpolicy", "response": [ + { + "description": "Number of consecutive health check success before declaring an instance healthy", + "name": "healthcheckthresshold", + "type": "int" + }, { "description": "the pingpath of the healthcheck policy", "name": "pingpath", "type": "string" }, { - "description": "Amount of time between health checks", - "name": "healthcheckinterval", - "type": "int" + "description": "is policy for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the LB HealthCheck policy ID", - "name": "id", - "type": "string" + "description": "Number of consecutive health check failures before declaring an instance unhealthy.", + "name": "unhealthcheckthresshold", + "type": "int" }, { "description": "the state of the policy", @@ -139489,14 +139848,14 @@ "type": "string" }, { - "description": "is policy for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the LB HealthCheck policy ID", + "name": "id", + "type": "string" }, { - "description": "Number of consecutive health check failures before declaring an instance unhealthy.", - "name": "unhealthcheckthresshold", - "type": "int" + "description": "the description of the healthcheck policy", + "name": "description", + "type": "string" }, { "description": "Time to wait when receiving a response from the health check", @@ -139504,18 +139863,45 @@ "type": "int" }, { - "description": "Number of consecutive health check success before declaring an instance healthy", - "name": "healthcheckthresshold", + "description": "Amount of time between health checks", + "name": "healthcheckinterval", "type": "int" - }, - { - "description": "the description of the healthcheck policy", - "name": "description", - "type": "string" } ], "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 LB rule ID", + "name": "lbruleid", + "type": "string" + }, + { + "description": "the account of the HealthCheck policy", + "name": "account", + "type": "string" + }, + { + "description": "the id of the zone the HealthCheck policy belongs to", + "name": "zoneid", + "type": "string" + }, + { + "description": "the domain ID of the HealthCheck policy", + "name": "domainid", + "type": "string" + }, + {} ], "since": "4.2.0" }, @@ -139525,18 +139911,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,324 +139930,374 @@ "related": "listSharedFileSystems,changeSharedFileSystemDiskOffering", "response": [ { - "description": "ID of the storage pool hosting the data volume", - "name": "storageid", + "description": "disk offering ID for the shared filesystem", + "name": "diskofferingid", "type": "string" }, { - "description": "the bytes actually consumed on disk", - "name": "physicalsize", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the write (IO) of disk on the shared filesystem", + "name": "diskiowrite", "type": "long" }, { - "description": "the shared filesystem provider", - "name": "provider", + "description": "service offering for the shared filesystem", + "name": "serviceofferingname", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", + "description": "ID of the shared filesystem", + "name": "id", + "type": "string" + }, + { + "description": "the state of the shared filesystem", + "name": "state", + "type": "string" + }, + { + "description": "the project ID of the shared filesystem", + "name": "projectid", + "type": "string" + }, + { + "description": "service offering ID for the shared filesystem", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the shared filesystem", + "name": "domainid", + "type": "string" + }, + { + "description": "size of the shared filesystem in GiB", + "name": "sizegb", + "type": "string" + }, + { + "description": "the account associated with the shared filesystem", + "name": "account", + "type": "string" + }, + {}, + { + "description": "the read (IO) of disk on the shared filesystem", + "name": "diskioread", + "type": "long" + }, + { + "description": "the shared filesystem's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "the disk utilization", + "name": "utilization", + "type": "string" + }, + { + "description": "the filesystem format", + "name": "filesystem", + "type": "string" + }, + { + "description": "path to mount the shared filesystem", + "name": "path", + "type": "string" + }, + { + "description": "ID of the storage fs vm", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the list of nics associated with the shared filesystem", + "name": "nic", "response": [ { - "description": "resource type", - "name": "resourcetype", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "description": "tag value", - "name": "value", + "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 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 project name where tag belongs to", - "name": "project", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" - } - ], - "type": "set" - }, - { - "description": "Name of the availability zone", - "name": "zonename", - "type": "string" - }, - { - "description": "disk offering display text for the shared filesystem", - "name": "diskofferingdisplaytext", - "type": "string" - }, - { - "description": "the shared filesystem's disk write in KiB", - "name": "diskkbswrite", - "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 IPv6 network", - "name": "ip6gateway", + "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 isolation uri of the nic", - "name": "isolationuri", - "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": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "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": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the name of the corresponding network", + "name": "networkname", "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", + "type": "list" }, { - "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 id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" - }, + } + ], + "type": "list" + }, + { + "description": "Name of the availability zone", + "name": "zonename", + "type": "string" + }, + { + "description": "size of the shared filesystem", + "name": "size", + "type": "long" + }, + { + "description": "the list of resource tags associated", + "name": "tags", + "response": [ { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" + "description": "customer associated with the tag", + "name": "customer", + "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "id of the resource", + "name": "resourceid", + "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "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": "tag value", + "name": "value", + "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": "Type of adapter if available", - "name": "adaptertype", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the account associated with the tag", + "name": "account", "type": "string" } ], - "type": "list" + "type": "set" }, { - "description": "disk offering for the shared filesystem", - "name": "diskofferingname", + "description": "the domain associated with the shared filesystem", + "name": "domain", "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", - "type": "string" - }, - { - "description": "name of the shared filesystem", - "name": "name", + "description": "name of the storage fs data volume", + "name": "volumename", "type": "string" }, + {}, { "description": "name of the storage pool hosting the data volume", "name": "storage", "type": "string" }, - { - "description": "ID of the storage fs data volume", - "name": "volumeid", - "type": "string" - }, { "description": "Network name of the shared filesystem", "name": "networkname", "type": "string" }, - {}, { - "description": "description of the shared filesystem", - "name": "description", + "description": "ID of the storage pool hosting the data volume", + "name": "storageid", "type": "string" }, { - "description": "disk offering ID for the shared filesystem", - "name": "diskofferingid", + "description": "ID of the storage fs data volume", + "name": "volumeid", "type": "string" }, { - "description": "ID of the shared filesystem", - "name": "id", + "description": "the project name of the shared filesystem", + "name": "project", "type": "string" }, - {}, { - "description": "Network ID of the shared filesystem", - "name": "networkid", + "description": "ID of the storage fs vm", + "name": "vmstate", "type": "string" }, { - "description": "the disk utilization", - "name": "utilization", + "description": "name of the shared filesystem", + "name": "name", "type": "string" }, { @@ -139870,28 +140306,13 @@ "type": "string" }, { - "description": "the account associated with the shared filesystem", - "name": "account", - "type": "string" - }, - { - "description": "name of the storage fs data volume", - "name": "volumename", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "disk offering display text for the shared filesystem", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "the shared filesystem's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "the domain associated with the shared filesystem", - "name": "domain", + "description": "disk offering for the shared filesystem", + "name": "diskofferingname", "type": "string" }, { @@ -139905,63 +140326,33 @@ "type": "boolean" }, { - "description": "size of the shared filesystem", - "name": "size", - "type": "long" - }, - { - "description": "size of the shared filesystem in GiB", - "name": "sizegb", - "type": "string" - }, - { - "description": "the write (IO) of disk on the shared filesystem", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the filesystem format", - "name": "filesystem", - "type": "string" - }, - { - "description": "the state of the shared filesystem", - "name": "state", + "description": "Network ID of the shared filesystem", + "name": "networkid", "type": "string" }, { - "description": "the project name of the shared filesystem", - "name": "project", + "description": "description of the shared filesystem", + "name": "description", "type": "string" }, { - "description": "the read (IO) of disk on the shared filesystem", - "name": "diskioread", + "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": "virtualmachineid", - "type": "string" + "description": "the shared filesystem's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "service offering ID for the shared filesystem", - "name": "serviceofferingid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "path to mount the shared filesystem", - "name": "path", + "description": "the shared filesystem provider", + "name": "provider", "type": "string" }, { @@ -139970,14 +140361,9 @@ "type": "string" }, { - "description": "ID of the storage fs vm", - "name": "vmstate", - "type": "string" - }, - { - "description": "the ID of the domain associated with the shared filesystem", - "name": "domainid", - "type": "string" + "description": "the bytes allocated", + "name": "virtualsize", + "type": "long" } ], "since": "4.20.0" @@ -139999,14 +140385,43 @@ "related": "disableUser,getUser,listUsers", "response": [ { - "description": "the account ID of the user", - "name": "accountid", + "description": "the user email address", + "name": "email", "type": "string" }, - {}, { - "description": "the name of the role", - "name": "rolename", + "description": "the domain name of the user", + "name": "domain", + "type": "string" + }, + { + "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", + "name": "apikeyaccess", + "type": "apikeyaccess" + }, + { + "description": "true if user 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 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 user name", + "name": "username", "type": "string" }, { @@ -140015,23 +140430,19 @@ "type": "string" }, { - "description": "the api key of the user", - "name": "apikey", + "description": "the ID of the role", + "name": "roleid", "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 user lastname", - "name": "lastname", - "type": "string" - }, - { - "description": "the user name", - "name": "username", + "description": "the name of the role", + "name": "rolename", "type": "string" }, { @@ -140044,46 +140455,56 @@ "name": "usersource", "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 firstname", - "name": "firstname", + "description": "the account name of the user", + "name": "account", "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 timezone user was created in", - "name": "timezone", + "description": "the user lastname", + "name": "lastname", "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 api key of the user", + "name": "apikey", + "type": "string" + }, { "description": "the user ID", "name": "id", "type": "string" }, { - "description": "the domain name of the user", - "name": "domain", + "description": "the account ID of the user", + "name": "accountid", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the timezone user was created in", + "name": "timezone", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", @@ -140091,49 +140512,14 @@ "type": "string" }, { - "description": "the account name of the user", - "name": "account", + "description": "the user firstname", + "name": "firstname", "type": "string" }, { "description": "the domain ID of the user", "name": "domainid", "type": "string" - }, - { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", - "type": "boolean" - }, - { - "description": "the ID of the role", - "name": "roleid", - "type": "string" - }, - { - "description": "the user email address", - "name": "email", - "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 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 account type of the user", - "name": "accounttype", - "type": "integer" } ] }, @@ -140144,27 +140530,27 @@ "params": [], "related": "", "response": [ + {}, + {}, + { + "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" }, - { - "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 Management Console base URL", + "name": "url", + "type": "string" } ], "since": "4.11.0" @@ -140175,115 +140561,128 @@ "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": "MTU to be configured on the network VR's private interface(s)", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "privatemtu", "required": false, - "type": "uuid" + "since": "4.18.0", + "type": "integer" }, { - "description": "the beginning IP address in the network IP range", + "description": "the name of the network", "length": 255, - "name": "startip", + "name": "name", + "required": true, + "type": "string" + }, + { + "description": "network domain", + "length": 255, + "name": "networkdomain", "required": false, "type": "string" }, { - "description": "the zone ID 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": "zoneid", - "related": "listZones", - "required": true, + "name": "acltype", + "required": false, + "type": "string" + }, + { + "description": "domain ID of the account owning a network. If the account is not specified, but the acltype is Account or not specified, the network will be automatically assigned to the caller account and domain. To create a network under the domain without linking it to any account, make sure to include acltype=Domain parameter in the api call. If account is not specified, but acltype is Domain, the network will be created for the specified domain.", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, "type": "uuid" }, { - "description": "MTU to be configured on the network VR's public facing interfaces", + "description": "the netmask of the network. Required for shared networks and isolated networks when it belongs to VPC", "length": 255, - "name": "publicmtu", + "name": "netmask", "required": false, - "since": "4.18.0", - "type": "integer" + "type": "string" }, { - "description": "IPV4 address to be assigned to a router in a shared network", + "description": "the beginning IPv6 address in the IPv6 network range", "length": 255, - "name": "routerip", + "name": "startipv6", "required": false, - "since": "4.16", "type": "string" }, { - "description": "the VPC network belongs to", + "description": "the second IPv6 DNS for the network", "length": 255, - "name": "vpcid", - "related": "listVPCs,createVPC,listVPCs,updateVPC", + "name": "ip6dns2", "required": false, - "type": "uuid" + "since": "4.18.0", + "type": "string" }, { - "description": "the network offering ID", + "description": "the CIDR size of IPv4 network. For regular users, this is required for isolated networks with ROUTED mode.", "length": 255, - "name": "networkofferingid", - "related": "listNetworkOfferings", - "required": true, - "type": "uuid" + "name": "cidrsize", + "required": false, + "since": "4.20.0", + "type": "integer" }, { - "description": "an optional field, whether to the display the network to the end user or not.", + "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": "displaynetwork", + "name": "subdomainaccess", "required": false, "type": "boolean" }, { - "description": "network domain", + "description": "the ID or VID of the network", "length": 255, - "name": "networkdomain", + "name": "vlan", "required": false, "type": "string" }, { - "description": "the isolated private VLAN for this network", + "description": "IPV6 address to be assigned to a router in a shared network", "length": 255, - "name": "isolatedpvlan", + "name": "routeripv6", "required": false, + "since": "4.16", "type": "string" }, { - "description": "the first IPv4 DNS for the network", + "description": "the second IPv4 DNS for the network", "length": 255, - "name": "dns1", + "name": "dns2", "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 display text of the network", "length": 255, - "name": "ip6cidr", + "name": "displaytext", "required": false, "type": "string" }, { - "description": "the second IPv4 DNS for the network", + "description": "the first IPv4 DNS for the network", "length": 255, - "name": "dns2", + "name": "dns1", "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": "Tungsten-Fabric virtual router the network belongs to", "length": 255, - "name": "gateway", + "name": "tungstenvirtualrouteruuid", "required": false, "type": "string" }, @@ -140296,61 +140695,78 @@ "type": "string" }, { - "description": "the netmask of the network. Required for shared networks and isolated networks when it belongs to VPC", + "description": "an optional project for the network", "length": 255, - "name": "netmask", + "name": "projectid", + "related": "", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "Network ACL ID associated for the network", + "description": "when true bypasses VLAN id/range overlap check during network creation for shared and L2 networks", "length": 255, - "name": "aclid", - "related": "createNetworkACLList", + "name": "bypassvlanoverlapcheck", + "required": false, + "type": "boolean" + }, + { + "description": "the VPC network belongs to", + "length": 255, + "name": "vpcid", + "related": "listVPCs,createVPC,listVPCs,updateVPC", "required": false, "type": "uuid" }, { - "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": "IPV4 address to be assigned to a router in a shared network", "length": 255, - "name": "acltype", + "name": "routerip", "required": false, + "since": "4.16", "type": "string" }, { - "description": "the display text of the network", + "description": "MTU to be configured on the network VR's public facing interfaces", "length": 255, - "name": "displaytext", + "name": "publicmtu", "required": false, - "type": "string" + "since": "4.18.0", + "type": "integer" }, { - "description": "Tungsten-Fabric virtual router the network belongs to", + "description": "Ids of the Bgp Peer for the network", "length": 255, - "name": "tungstenvirtualrouteruuid", + "name": "bgppeerids", + "related": "", + "required": false, + "since": "4.20.0", + "type": "list" + }, + { + "description": "the beginning IP address in the network IP range", + "length": 255, + "name": "startip", "required": false, "type": "string" }, { - "description": "the AS Number of the network", + "description": "the isolated private VLAN for this network", "length": 255, - "name": "asnumber", + "name": "isolatedpvlan", "required": false, - "since": "4.20.0", - "type": "long" + "type": "string" }, { - "description": "the second IPv6 DNS for the network", + "description": "the isolated private VLAN type for this network", "length": 255, - "name": "ip6dns2", + "name": "isolatedpvlantype", "required": false, - "since": "4.18.0", "type": "string" }, { - "description": "ID of the network in an external system.", + "description": "the gateway of the IPv6 network. Required for Shared networks", "length": 255, - "name": "externalid", + "name": "ip6gateway", "required": false, "type": "string" }, @@ -140364,62 +140780,56 @@ "type": "uuid" }, { - "description": "the ending IPv6 address in the IPv6 network range", + "description": "the gateway of the network. Required for shared networks and isolated networks when it belongs to VPC", "length": 255, - "name": "endipv6", + "name": "gateway", "required": false, "type": "string" }, { - "description": "the CIDR size of IPv4 network. For regular users, this is required for isolated networks with ROUTED mode.", + "description": "ID of the network in an external system.", "length": 255, - "name": "cidrsize", + "name": "externalid", "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": "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": "bypassvlanoverlapcheck", + "name": "sourcenatipaddress", "required": false, - "type": "boolean" + "since": "4.19", + "type": "string" }, { - "description": "the beginning IPv6 address in the IPv6 network range", + "description": "the CIDR of IPv6 network, must be at least /64", "length": 255, - "name": "startipv6", + "name": "ip6cidr", "required": false, "type": "string" }, { - "description": "an optional project for the network", + "description": "the network offering ID", "length": 255, - "name": "projectid", - "related": "", - "required": false, + "name": "networkofferingid", + "related": "listNetworkOfferings", + "required": true, "type": "uuid" }, { - "description": "the isolated private VLAN type for this network", + "description": "the ending IPv6 address in the IPv6 network range", "length": 255, - "name": "isolatedpvlantype", + "name": "endipv6", "required": false, "type": "string" }, { - "description": "Account that will own the network. Account should be under the selected domain", + "description": "the physical network ID the network belongs to", "length": 255, - "name": "account", + "name": "physicalnetworkid", + "related": "", "required": false, - "type": "string" - }, - { - "description": "the name of the network", - "length": 255, - "name": "name", - "required": true, - "type": "string" + "type": "uuid" }, { "description": "the ending IP address in the network IP range. If not specified, will be defaulted to startIP", @@ -140429,83 +140839,174 @@ "type": "string" }, { - "description": "when true ip address usage for the network will not be exported by the listUsageRecords API", + "description": "an optional field, whether to the display the network to the end user or not.", "length": 255, - "name": "hideipaddressusage", + "name": "displaynetwork", "required": false, "type": "boolean" }, { - "description": "the physical network ID the network belongs to", + "description": "the zone ID for the network", "length": 255, - "name": "physicalnetworkid", - "related": "", - "required": false, + "name": "zoneid", + "related": "listZones", + "required": true, "type": "uuid" }, { - "description": "the ID or VID of the network", + "description": "the AS Number of the network", "length": 255, - "name": "vlan", + "name": "asnumber", "required": false, - "type": "string" + "since": "4.20.0", + "type": "long" }, { - "description": "Ids of the Bgp Peer for the network", + "description": "Network ACL ID associated for the network", "length": 255, - "name": "bgppeerids", - "related": "", + "name": "aclid", + "related": "createNetworkACLList", "required": false, - "since": "4.20.0", - "type": "list" + "type": "uuid" }, { - "description": "MTU to be configured on the network VR's private interface(s)", + "description": "Account that will own the network. Account should be under the selected domain", "length": 255, - "name": "privatemtu", + "name": "account", "required": false, - "since": "4.18.0", - "type": "integer" + "type": "string" + } + ], + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", + "response": [ + { + "description": "the domain name of the network owner", + "name": "domain", + "type": "string" }, { - "description": "the gateway of the IPv6 network. Required for Shared networks", - "length": 255, + "description": "The IPv4 routing type of network", + "name": "ip4routing", + "type": "string" + }, + { + "description": "the id of the network", + "name": "id", + "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", + "type": "string" + }, + { + "description": "true if network can span multiple zones", + "name": "strechedl2subnet", + "type": "boolean" + }, + { + "description": "The Ipv6 routing type of network offering", + "name": "ip6routing", + "type": "string" + }, + { + "description": "the name of the network", + "name": "name", + "type": "string" + }, + { + "description": "the network's netmask", + "name": "netmask", + "type": "string" + }, + { + "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": "If the network has redundant routers enabled", + "name": "redundantrouter", + "type": "boolean" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "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 owner of the network", + "name": "account", + "type": "string" + }, + { + "description": "the project name of the address", + "name": "project", + "type": "string" + }, + { + "description": "the details of the network", + "name": "details", + "type": "map" + }, + { + "description": "the gateway of IPv6 network", "name": "ip6gateway", - "required": false, "type": "string" }, { - "description": "IPV6 address to be assigned to a router in a shared network", - "length": 255, - "name": "routeripv6", - "required": false, - "since": "4.16", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "IPV4 address to be assigned to the public interface of the network router. This address will be used as source NAT address for the network. \nIf an address is given and it cannot be acquired, an error will be returned and the network won´t be implemented,", - "length": 255, - "name": "sourcenatipaddress", - "required": false, - "since": "4.19", + "description": "the name of the Network associated with this private gateway", + "name": "associatednetwork", "type": "string" - } - ], - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", - "response": [ + }, { - "description": "Tungsten-Fabric virtual router the network belongs to", - "name": "tungstenvirtualrouteruuid", + "description": "path of the Domain the network belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the displaytext of the network", - "name": "displaytext", + "description": "true if network supports specifying ip ranges, false otherwise", + "name": "specifyipranges", + "type": "boolean" + }, + { + "description": "ACL Id associated with the VPC network", + "name": "aclid", "type": "string" }, { - "description": "availability of the network offering the network is created from", - "name": "networkofferingavailability", + "description": "list networks that are persistent", + "name": "ispersistent", + "type": "boolean" + }, + { + "description": "ACL name associated with the VPC network", + "name": "aclname", "type": "string" }, { @@ -140513,13 +141014,19 @@ "name": "related", "type": "string" }, + {}, + { + "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", + "name": "cidr", + "type": "string" + }, { "description": "the list of resource tags associated with network", "name": "tags", "response": [ { - "description": "tag key name", - "name": "key", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -140528,23 +141035,23 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "resource type", + "name": "resourcetype", "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 domain associated with the tag", - "name": "domain", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -140553,97 +141060,81 @@ "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": "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" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" } ], "type": "list" }, { - "description": "true if network offering is ip conserve mode enabled", - "name": "networkofferingconservemode", + "description": "list networks available for vm deployment", + "name": "canusefordeploy", "type": "boolean" }, { - "description": "ACL Id associated with the VPC network", - "name": "aclid", - "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": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "zone id of the network", - "name": "zoneid", + "description": "display text of the network offering the network is created from", + "name": "networkofferingdisplaytext", "type": "string" }, { - "description": "true if network supports specifying ip ranges, false otherwise", - "name": "specifyipranges", + "description": "true if network supports specifying vlan, false otherwise", + "name": "specifyvlan", "type": "boolean" }, { - "description": "if network offering supports vm autoscaling feature", - "name": "supportsvmautoscaling", - "type": "boolean" + "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", + "name": "zonesnetworkspans", + "type": "set" }, { - "description": "The internet protocol of network offering", - "name": "internetprotocol", + "description": "the second IPv6 DNS for the network", + "name": "ip6dns2", "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "The external id of the network", + "name": "externalid", "type": "string" }, { - "description": "true if network can span multiple zones", - "name": "strechedl2subnet", - "type": "boolean" + "description": "the first IPv6 DNS for the network", + "name": "ip6dns1", + "type": "string" }, { "description": "true if the entity/resource has annotations", "name": "hasannotations", "type": "boolean" }, - {}, - { - "description": "VPC the network belongs to", - "name": "vpcid", - "type": "string" - }, - { - "description": "the domain id of the network owner", - "name": "domainid", - "type": "string" - }, { - "description": "the name of the zone the network belongs to", - "name": "zonename", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -140652,19 +141143,14 @@ "type": "boolean" }, { - "description": "The external id of the network", - "name": "externalid", - "type": "string" - }, - { - "description": "the traffic type of the network", - "name": "traffictype", - "type": "string" + "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": "AS NUMBER", + "name": "asnumber", + "type": "long" }, { "description": "Name of the VPC to which this network belongs", @@ -140672,73 +141158,43 @@ "type": "string" }, { - "description": "the second IPv6 DNS for the network", - "name": "ip6dns2", - "type": "string" - }, - { - "description": "path of the Domain the network belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "The Ipv6 routing type of network offering", - "name": "ip6routing", - "type": "string" - }, - { - "description": "display text of the network offering the network is created from", - "name": "networkofferingdisplaytext", + "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", + "name": "broadcasturi", "type": "string" }, - { - "description": "the details of the network", - "name": "details", - "type": "map" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "state of the network", - "name": "state", - "type": "string" - }, - { - "description": "the type of the network", - "name": "type", + "description": "network offering id the network is created from", + "name": "networkofferingid", "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", + "description": "The internet protocol of network offering", + "name": "internetprotocol", "type": "string" }, { - "description": "The IPv4 routing type of network", - "name": "ip4routing", + "description": "the network's gateway", + "name": "gateway", "type": "string" }, { - "description": "the physical network id", - "name": "physicalnetworkid", - "type": "string" + "description": "true if network is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the project name of the address", - "name": "project", + "description": "name of the network offering the network is created from", + "name": "networkofferingname", "type": "string" }, { - "description": "Broadcast domain type of the network", - "name": "broadcastdomaintype", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { @@ -140747,33 +141203,18 @@ "type": "boolean" }, { - "description": "the first IPv4 DNS for the network", - "name": "dns1", - "type": "string" - }, - { - "description": "the name of the Network associated with this private gateway", - "name": "associatednetwork", - "type": "string" - }, - { - "description": "ACL name associated with the VPC network", - "name": "aclname", - "type": "string" - }, - { - "description": "true network requires restart", - "name": "restartrequired", - "type": "boolean" + "description": "The BGP peers for the network", + "name": "bgppeers", + "type": "set" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "zone id of the network", + "name": "zoneid", "type": "string" }, { - "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", - "name": "cidr", + "description": "the first IPv4 DNS for the network", + "name": "dns1", "type": "string" }, { @@ -140781,70 +141222,70 @@ "name": "service", "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": "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 capability name", + "description": "the provider 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", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the provider name", + "description": "services for this provider", + "name": "servicelist", + "type": "list" + } + ], + "type": "list" + }, + { + "description": "the service name", + "name": "name", + "type": "string" + }, + { + "description": "the list of capabilities", + "name": "capability", + "response": [ + { + "description": "the capability name", "name": "name", "type": "string" }, { - "description": "services for this provider", - "name": "servicelist", - "type": "list" + "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" @@ -140853,83 +141294,23 @@ "type": "list" }, { - "description": "network offering id the network is created from", - "name": "networkofferingid", - "type": "string" - }, - { - "description": "the project id of the ipaddress", - "name": "projectid", - "type": "string" - }, - { - "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "AS NUMBER", - "name": "asnumber", - "type": "long" - }, - { - "description": "If the network has redundant routers enabled", - "name": "redundantrouter", - "type": "boolean" - }, - { - "description": "the name of the network", - "name": "name", - "type": "string" - }, - { - "description": "The vlan of the network. This parameter is visible to ROOT admins only", - "name": "vlan", - "type": "string" - }, - { - "description": "the date this network was created", - "name": "created", - "type": "date" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", - "name": "zonesnetworkspans", - "type": "set" - }, - { - "description": "acl type - access type to the network", - "name": "acltype", + "description": "the domain id of the network owner", + "name": "domainid", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "list networks that are persistent", - "name": "ispersistent", + "description": "true network requires restart", + "name": "restartrequired", "type": "boolean" }, { - "description": "The BGP peers for the network", - "name": "bgppeers", - "type": "set" - }, - { - "description": "true if network is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the displaytext of the network", + "name": "displaytext", + "type": "string" }, { - "description": "name of the network offering the network is created from", - "name": "networkofferingname", + "description": "availability of the network offering the network is created from", + "name": "networkofferingavailability", "type": "string" }, { @@ -140938,85 +141319,90 @@ "type": "set" }, { - "description": "the second IPv4 DNS for the network", - "name": "dns2", + "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 network's netmask", - "name": "netmask", + "description": "the physical network id", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "Broadcast domain type of the network", + "name": "broadcastdomaintype", "type": "string" }, { - "description": "the owner of the network", - "name": "account", + "description": "state of the network", + "name": "state", "type": "string" }, { - "description": "the ID of the Network associated with this private gateway", - "name": "associatednetworkid", + "description": "the traffic type of the network", + "name": "traffictype", "type": "string" }, - {}, { - "description": "true if users from subdomains can access the domain level network", - "name": "subdomainaccess", + "description": "the network domain", + "name": "networkdomain", + "type": "string" + }, + { + "description": "MTU configured on the network VR's private interfaces", + "name": "privatemtu", + "type": "integer" + }, + { + "description": "if network offering supports vm autoscaling feature", + "name": "supportsvmautoscaling", "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 type of the network", + "name": "type", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the second IPv4 DNS for the network", + "name": "dns2", + "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "VPC the network belongs to", + "name": "vpcid", + "type": "string" }, + {}, { - "description": "the id of the network", - "name": "id", + "description": "the name of the zone the network belongs to", + "name": "zonename", "type": "string" }, { - "description": "UUID of AS NUMBER", - "name": "asnumberid", + "description": "Tungsten-Fabric virtual router the network belongs to", + "name": "tungstenvirtualrouteruuid", "type": "string" }, { - "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": "MTU configured on the network VR's public facing interfaces", - "name": "publicmtu", - "type": "integer" + "description": "the ID of the Network associated with this private gateway", + "name": "associatednetworkid", + "type": "string" }, { - "description": "the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes", - "name": "reservediprange", + "description": "UUID of AS NUMBER", + "name": "asnumberid", "type": "string" }, { - "description": "true if network is system, false otherwise", - "name": "issystem", + "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", - "type": "set" } ] }, @@ -141028,54 +141414,52 @@ { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "list network offerings available for network creation in specific domain", + "description": "the tags for the network offering.", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "specifyvlan", "required": false, - "since": "4.13", - "type": "uuid" + "type": "boolean" }, { - "description": "the availability of network offering. Default value is required", + "description": "list network offerings by guest type: shared or isolated", "length": 255, - "name": "availability", + "name": "guestiptype", "required": false, "type": "string" }, { - "description": "true if need to list only network offerings which support specifying ip ranges", + "description": "true if need to list only netwok offerings where source NAT is supported, false otherwise", "length": 255, - "name": "specifyipranges", + "name": "sourcenatsupported", "required": false, "type": "boolean" }, { - "description": "list network offerings by display text", - "length": 255, - "name": "displaytext", + "description": "list network offerings by tags", + "length": 4096, + "name": "tags", "required": false, "type": "string" }, { - "description": "list network offerings by ID", + "description": "the routing mode for the network offering. Supported types are: Static or Dynamic.", "length": 255, - "name": "id", - "related": "listNetworkOfferings", + "name": "routingmode", "required": false, - "type": "uuid" + "since": "4.20.0", + "type": "string" }, { - "description": "list network offerings by state", + "description": "the network offering can be used only for network creation inside the VPC", "length": 255, - "name": "state", + "name": "forvpc", "required": false, - "type": "string" + "type": "boolean" }, { "description": "list network offerings available for network creation in specific zone", @@ -141086,126 +141470,118 @@ "type": "uuid" }, { - "description": "true if offering has tags specified", + "description": "list by traffic type", "length": 255, - "name": "istagged", - "required": false, - "type": "boolean" - }, - { - "description": "list network offerings by tags", - "length": 4096, - "name": "tags", + "name": "traffictype", "required": false, "type": "string" }, { - "description": "the tags for the network offering.", + "description": "List by keyword", "length": 255, - "name": "specifyvlan", + "name": "keyword", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "true if need to list only netwok offerings where source NAT is supported, false otherwise", + "description": "the availability of network offering. Default value is required", "length": 255, - "name": "sourcenatsupported", + "name": "availability", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "List by keyword", + "description": "list network offerings by display text", "length": 255, - "name": "keyword", + "name": "displaytext", "required": false, "type": "string" }, { - "description": "the network offering can be used only for network creation inside the VPC", + "description": "true if need to list only default network offerings. Default value is false", "length": 255, - "name": "forvpc", + "name": "isdefault", "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 state", "length": 255, - "name": "name", + "name": "state", "required": false, "type": "string" }, { - "description": "list by traffic type", + "description": "list network offerings supporting certain services", "length": 255, - "name": "traffictype", + "name": "supportedservices", "required": false, - "type": "string" + "type": "list" }, { - "description": "list network offerings by guest type: shared or isolated", + "description": "true if need to list only network offerings which support specifying ip ranges", "length": 255, - "name": "guestiptype", + "name": "specifyipranges", "required": false, - "type": "string" + "type": "boolean" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "list network offerings supporting certain services", + "description": "list network offerings by name", "length": 255, - "name": "supportedservices", + "name": "name", "required": false, - "type": "list" + "type": "string" }, { - "description": "true if need to list only default network offerings. Default value is false", + "description": "list network offerings by ID", "length": 255, - "name": "isdefault", + "name": "id", + "related": "listNetworkOfferings", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "the routing mode for the network offering. Supported types are: Static or Dynamic.", + "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": "routingmode", + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", "required": false, - "since": "4.20.0", - "type": "string" + "type": "uuid" + }, + { + "description": "true if offering has tags specified", + "length": 255, + "name": "istagged", + "required": false, + "type": "boolean" } ], "related": "", "response": [ { - "description": "maximum number of concurrents connections to be handled by lb", - "name": "maxconnections", - "type": "integer" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the tags for the network offering", - "name": "tags", + "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 network offering", - "name": "id", + "description": "the name of the network offering", + "name": "name", "type": "string" }, { @@ -141214,24 +141590,18 @@ "type": "boolean" }, { - "description": "the ID of the service offering used by virtual router provider", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "additional key/value details tied with network offering", - "name": "details", - "type": "map" + "description": "maximum number of concurrents connections to be handled by lb", + "name": "maxconnections", + "type": "integer" }, - {}, { - "description": "true if network offering supports vlans, false otherwise", - "name": "specifyvlan", - "type": "boolean" + "description": "availability of the network offering", + "name": "availability", + "type": "string" }, { - "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domainid", + "description": "an alternate display text of the network offering.", + "name": "displaytext", "type": "string" }, { @@ -141240,43 +141610,23 @@ "type": "boolean" }, { - "description": "true if network offering can be used by VPC networks only", - "name": "forvpc", - "type": "boolean" - }, - { - "description": "true if network offering supports public access for guest networks", - "name": "supportspublicaccess", - "type": "boolean" - }, - { - "description": "true if network offering supports persistent networks, false otherwise", - "name": "ispersistent", - "type": "boolean" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if network offering can be used by Tungsten-Fabric networks only", + "name": "fortungsten", "type": "boolean" }, { - "description": "availability of the network offering", - "name": "availability", - "type": "string" - }, - { - "description": "an alternate display text of the network offering.", - "name": "displaytext", + "description": "guest type of the network offering, can be Shared or Isolated", + "name": "guestiptype", "type": "string" }, { - "description": "true if network offering is default, false otherwise", - "name": "isdefault", + "description": "true if network offering supports specifying ip ranges, false otherwise", + "name": "specifyipranges", "type": "boolean" }, { - "description": "Mode in which the network will operate. The valid values are NATTED and ROUTED", - "name": "networkmode", + "description": "the ID of the service offering used by virtual router provider", + "name": "serviceofferingid", "type": "string" }, { @@ -141284,52 +141634,52 @@ "name": "specifyasnumber", "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": "data transfer rate in megabits per second allowed.", "name": "networkrate", "type": "integer" }, { - "description": "the traffic type for the network offering, supported types are Public, Management, Control, Guest, Vlan or Storage.", - "name": "traffictype", - "type": "string" + "description": "additional key/value details tied with network offering", + "name": "details", + "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 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 NSX networks only", - "name": "fornsx", - "type": "boolean" + "description": "the id of the network offering", + "name": "id", + "type": "string" }, { - "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zoneid", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the date this network offering was created", - "name": "created", - "type": "date" + "description": "true if network offering can be used by NSX networks only", + "name": "fornsx", + "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": "the provider name", - "name": "name", + "description": "state of the network provider", + "name": "state", "type": "string" }, { @@ -141337,11 +141687,21 @@ "name": "destinationphysicalnetworkid", "type": "string" }, + { + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" + }, { "description": "uuid of the network provider", "name": "id", "type": "string" }, + { + "description": "the provider name", + "name": "name", + "type": "string" + }, { "description": "the physical network this belongs to", "name": "physicalnetworkid", @@ -141351,16 +141711,6 @@ "description": "services for this provider", "name": "servicelist", "type": "list" - }, - { - "description": "state of the network provider", - "name": "state", - "type": "string" - }, - { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" } ], "type": "list" @@ -141386,34 +141736,23 @@ } ], "type": "list" - }, - { - "description": "the service name", - "name": "name", - "type": "string" } ], "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", + "description": "Mode in which the network will operate. The valid values are NATTED and ROUTED", + "name": "networkmode", "type": "string" }, - {}, { - "description": "state of the network offering. Can be Disabled/Enabled/Inactive", - "name": "state", + "description": "the traffic type for the network offering, supported types are Public, Management, Control, Guest, Vlan or Storage.", + "name": "traffictype", "type": "string" }, { - "description": "true if network offering can be used by Tungsten-Fabric networks only", - "name": "fortungsten", + "description": "true if network offering is default, false otherwise", + "name": "isdefault", "type": "boolean" }, { @@ -141422,28 +141761,75 @@ "type": "integer" }, { - "description": "the routing mode for the network offering, supported types are Static or Dynamic.", - "name": "routingmode", - "type": "string" + "description": "true if network offering supports vlans, false otherwise", + "name": "specifyvlan", + "type": "boolean" + }, + { + "description": "the date this network offering was created", + "name": "created", + "type": "date" + }, + { + "description": "true if network offering supports persistent networks, false otherwise", + "name": "ispersistent", + "type": "boolean" }, { "description": "the internet protocol of the network offering", "name": "internetprotocol", "type": "string" }, + { + "description": "the tags for the network offering", + "name": "tags", + "type": "string" + }, + { + "description": "true if network offering can be used by VPC networks only", + "name": "forvpc", + "type": "boolean" + }, { "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", + "description": "the routing mode for the network offering, supported types are Static or Dynamic.", + "name": "routingmode", + "type": "string" + }, + { + "description": "state of the network offering. Can be Disabled/Enabled/Inactive", + "name": "state", + "type": "string" + }, + { + "description": "true if network offering supports public access for guest networks", + "name": "supportsinternallb", + "type": "boolean" + }, + {}, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "true if network offering supports public access for guest networks", + "name": "supportspublicaccess", "type": "boolean" }, { - "description": "guest type of the network offering, can be Shared or Isolated", - "name": "guestiptype", + "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zone", + "type": "string" + }, + { + "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domain", "type": "string" } ] @@ -141453,28 +141839,6 @@ "isasync": false, "name": "listDedicatedPods", "params": [ - { - "description": "the name of the account associated with the pod. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, - { - "description": "list dedicated pods by affinity group", - "length": 255, - "name": "affinitygroupid", - "related": "", - "required": false, - "type": "uuid" - }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, { "description": "the ID of the pod", "length": 255, @@ -141497,6 +141861,21 @@ "required": false, "type": "integer" }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "list dedicated pods by affinity group", + "length": 255, + "name": "affinitygroupid", + "related": "", + "required": false, + "type": "uuid" + }, { "description": "the ID of the domain associated with the pod", "length": 255, @@ -141504,19 +141883,26 @@ "related": "listDomains", "required": false, "type": "uuid" + }, + { + "description": "the name of the account associated with the pod. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, + "type": "string" } ], "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", + "description": "the domain ID to which the Pod is dedicated", + "name": "domainid", "type": "string" }, { @@ -141525,30 +141911,30 @@ "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 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 Name of the Pod", + "name": "podname", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the dedicated resource", + "name": "id", "type": "string" }, {}, { - "description": "the ID of the Pod", - "name": "podid", + "description": "the Account Id to which the Pod is dedicated", + "name": "accountid", "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -141558,46 +141944,48 @@ "name": "listVPCs", "params": [ { - "description": "List resources by tags (key/value pairs)", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "tags", + "name": "isrecursive", "required": false, - "type": "map" + "type": "boolean" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "listall", + "name": "fordisplay", "required": false, + "since": "4.4", "type": "boolean" }, { - "description": "list VPC supporting certain services", + "description": "list by name of the VPC", "length": 255, - "name": "supportedservices", + "name": "name", "required": false, - "type": "list" + "type": "string" }, { - "description": "flag to display the resource icon for VPCs", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "showicon", + "name": "account", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "list by zone", "length": 255, - "name": "isrecursive", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "list VPCs by restartRequired option", + "description": "list VPCs by state", "length": 255, - "name": "restartrequired", + "name": "state", "required": false, - "type": "boolean" + "type": "string" }, { "description": "list VPC by id", @@ -141608,34 +141996,32 @@ "type": "uuid" }, { - "description": "list by ID of the VPC offering", + "description": "list VPC supporting certain services", "length": 255, - "name": "vpcofferingid", - "related": "updateVPCOffering", + "name": "supportedservices", "required": false, - "type": "uuid" + "type": "list" }, { - "description": "list by cidr of the VPC. All VPC guest networks' cidrs should be within this CIDR", + "description": "List by display text of the VPC", "length": 255, - "name": "cidr", + "name": "displaytext", "required": false, "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 VPCs by state", + "description": "", "length": 255, - "name": "state", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { "description": "list only resources belonging to the domain specified", @@ -141646,111 +142032,86 @@ "type": "uuid" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "list VPCs by restartRequired option", "length": 255, - "name": "account", + "name": "restartrequired", "required": false, - "type": "string" + "type": "boolean" }, { - "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": "flag to display the resource icon for VPCs", "length": 255, - "name": "page", + "name": "showicon", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "list by zone", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources 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": "zoneid", - "related": "listZones", + "name": "listall", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "", + "description": "list by ID of the VPC offering", "length": 255, - "name": "pagesize", + "name": "vpcofferingid", + "related": "updateVPCOffering", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "list by name of the VPC", + "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": "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 tags (key/value pairs)", "length": 255, - "name": "keyword", + "name": "tags", "required": false, - "type": "string" + "type": "map" } ], "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", + "description": "the second IPv4 DNS for the VPC", + "name": "dns2", "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" }, { - "description": "the domain path of the owner", - "name": "domainpath", + "description": "the name of the zone the VPC belongs to", + "name": "zonename", "type": "string" }, { - "description": "zone id of the vpc", - "name": "zoneid", + "description": "the domain name of the owner", + "name": "domain", "type": "string" }, - { - "description": "MTU configured on the public interfaces of the VPC VR", - "name": "publicmtu", - "type": "integer" - }, { "description": "UUID of AS NUMBER", "name": "asnumberid", @@ -141762,28 +142123,8 @@ "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", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -141791,292 +142132,296 @@ "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": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { - "description": "vpc offering id the VPC is created from", - "name": "vpcofferingid", - "type": "string" + "description": "is vpc for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the list of supported services", - "name": "service", + "description": "the list of resource tags associated with the project", + "name": "tags", "response": [ { - "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", - "type": "string" - }, - { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" - }, - { - "description": "state of the network provider", - "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" - } - ], - "type": "list" + "description": "tag value", + "name": "value", + "type": "string" }, { - "description": "the service name", - "name": "name", + "description": "id of the resource", + "name": "resourceid", "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 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": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "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" } ], "type": "list" }, + { + "description": "the second IPv6 DNS for the VPC", + "name": "ip6dns2", + "type": "string" + }, + { + "description": "is VPC uses distributed router for one hop forwarding and host based network ACL's", + "name": "distributedvpcrouter", + "type": "boolean" + }, + { + "description": "the id of the VPC", + "name": "id", + "type": "string" + }, { "description": "the list of networks belongign to the VPC", "name": "network", "type": "list" }, { - "description": "the name of the VPC", - "name": "name", + "description": "the project name of the VPC", + "name": "project", "type": "string" }, { - "description": "The BGP peers for the VPC", - "name": "bgppeers", + "description": "if this VPC has redundant router", + "name": "redundantvpcrouter", + "type": "boolean" + }, + { + "description": "an alternate display text of the VPC.", + "name": "displaytext", + "type": "string" + }, + { + "description": "the owner of the VPC", + "name": "account", + "type": "string" + }, + { + "description": "AS NUMBER", + "name": "asnumber", + "type": "long" + }, + { + "description": "vpc offering name the VPC is created from", + "name": "vpcofferingname", + "type": "string" + }, + { + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", "type": "set" }, + { + "description": "the date this VPC was created", + "name": "created", + "type": "date" + }, + { + "description": "the first IPv6 DNS for the VPC", + "name": "ip6dns1", + "type": "string" + }, + {}, { "description": "the cidr the VPC", "name": "cidr", "type": "string" }, { - "description": "the id of the VPC", - "name": "id", + "description": "the domain path of the owner", + "name": "domainpath", "type": "string" }, { - "description": "the owner of the VPC", - "name": "account", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the second IPv4 DNS for the VPC", - "name": "dns2", - "type": "string" + "description": "MTU configured on the public interfaces of the VPC VR", + "name": "publicmtu", + "type": "integer" }, { - "description": "AS NUMBER", - "name": "asnumber", - "type": "long" + "description": "The BGP peers for the VPC", + "name": "bgppeers", + "type": "set" }, - {}, { - "description": "is VPC uses distributed router for one hop forwarding and host based network ACL's", - "name": "distributedvpcrouter", + "description": "true if VPC is region level", + "name": "regionlevelvpc", "type": "boolean" }, { - "description": "the domain name of the owner", - "name": "domain", + "description": "state of the VPC. Can be Inactive/Enabled", + "name": "state", "type": "string" }, + {}, { - "description": "The routes for the VPC to ease adding route in upstream router", - "name": "ip4routes", - "type": "set" + "description": "true VPC requires restart", + "name": "restartrequired", + "type": "boolean" }, { - "description": "an alternate display text of the VPC.", - "name": "displaytext", + "description": "vpc offering id the VPC is created from", + "name": "vpcofferingid", "type": "string" }, { - "description": "the list of resource tags associated with the project", - "name": "tags", + "description": "the list of supported services", + "name": "service", "response": [ { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", + "description": "the service name", + "name": "name", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", - "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": "id of the resource", - "name": "resourceid", - "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": "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": "the destination physical network", + "name": "destinationphysicalnetworkid", + "type": "string" + }, + { + "description": "uuid of the network provider", + "name": "id", + "type": "string" + } + ], + "type": "list" } ], "type": "list" }, { - "description": "true if VPC is region level", - "name": "regionlevelvpc", - "type": "boolean" - } - ] - }, - { - "description": "Adds a network device of one of the following types: ExternalDhcp, ExternalFirewall, ExternalLoadBalancer, PxeServer", - "isasync": false, - "name": "addNetworkDevice", - "params": [ - { - "description": "Network device type, now supports ExternalDhcp, PxeServer, NetscalerMPXLoadBalancer, NetscalerVPXLoadBalancer, NetscalerSDXLoadBalancer, F5BigIpLoadBalancer, JuniperSRXFirewall, PaloAltoFirewall", - "length": 255, - "name": "networkdevicetype", - "required": false, - "type": "string" + "description": "The routes for the VPC to ease adding route in upstream router", + "name": "ip4routes", + "type": "set" }, { - "description": "parameters for network device", - "length": 255, - "name": "networkdeviceparameterlist", - "required": false, - "type": "map" - } - ], - "related": "", - "response": [ - { - "description": "the ID of the network device", - "name": "id", + "description": "the network domain of the VPC", + "name": "networkdomain", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "zone id of the vpc", + "name": "zoneid", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {} + "description": "the first IPv4 DNS for the VPC", + "name": "dns1", + "type": "string" + } ] }, { @@ -142092,6 +142437,13 @@ "required": true, "type": "uuid" }, + { + "description": "The IP/Domain address to test connection to", + "length": 255, + "name": "ipaddress", + "required": true, + "type": "string" + }, { "description": "Additional command line options that apply for each command", "length": 255, @@ -142105,46 +142457,80 @@ "name": "type", "required": true, "type": "string" - }, - { - "description": "The IP/Domain address to test connection to", - "length": 255, - "name": "ipaddress", - "required": true, - "type": "string" } ], "related": "", "response": [ + { + "description": "the standard output from the command execution", + "name": "stdout", + "type": "string" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + { + "description": "the command execution return code", + "name": "exitcode", + "type": "string" + }, + { + "description": "the standard error output from the command execution", + "name": "stderr", + "type": "string" + }, + {}, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, + } + ], + "since": "4.12.0.0" + }, + { + "description": "Adds a network device of one of the following types: ExternalDhcp, ExternalFirewall, ExternalLoadBalancer, PxeServer", + "isasync": false, + "name": "addNetworkDevice", + "params": [ { - "description": "the standard output from the command execution", - "name": "stdout", + "description": "Network device type, now supports ExternalDhcp, PxeServer, NetscalerMPXLoadBalancer, NetscalerVPXLoadBalancer, NetscalerSDXLoadBalancer, F5BigIpLoadBalancer, JuniperSRXFirewall, PaloAltoFirewall", + "length": 255, + "name": "networkdevicetype", + "required": false, "type": "string" }, { - "description": "the command execution return code", - "name": "exitcode", + "description": "parameters for network device", + "length": 255, + "name": "networkdeviceparameterlist", + "required": false, + "type": "map" + } + ], + "related": "", + "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the ID of the network device", + "name": "id", "type": "string" }, {}, {}, { - "description": "the standard error output from the command execution", - "name": "stderr", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } - ], - "since": "4.12.0.0" + ] }, { "description": "Restarts a VPC", @@ -142152,10 +142538,11 @@ "name": "restartVPC", "params": [ { - "description": "Turn a single VPC into a redundant one.", + "description": "Live patches the router software before restarting it. This parameter will only work when 'cleanup' is false.", "length": 255, - "name": "makeredundant", + "name": "livepatch", "required": false, + "since": "4.17.0", "type": "boolean" }, { @@ -142165,6 +142552,13 @@ "required": false, "type": "boolean" }, + { + "description": "Turn a single VPC into a redundant one.", + "length": 255, + "name": "makeredundant", + "required": false, + "type": "boolean" + }, { "description": "the id of the VPC", "length": 255, @@ -142172,14 +142566,6 @@ "related": "createVPC,listVPCs,updateVPC", "required": true, "type": "uuid" - }, - { - "description": "Live patches the router software before restarting it. This parameter will only work when 'cleanup' is false.", - "length": 255, - "name": "livepatch", - "required": false, - "since": "4.17.0", - "type": "boolean" } ], "response": [ @@ -142189,16 +142575,16 @@ "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", @@ -142226,6 +142612,13 @@ "required": false, "type": "boolean" }, + { + "description": "New quota account min balance", + "length": 255, + "name": "minbalance", + "required": false, + "type": "double" + }, { "description": "Account ID for which to configure quota template email or min balance", "length": 255, @@ -142233,43 +142626,36 @@ "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 configured account's id.", + "name": "account", + "type": "string" }, {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The template's name.", + "name": "templatename", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, { - "description": "The configured account's id.", - "name": "account", - "type": "string" + "description": "The configured account's min balance.", + "name": "minbalance", + "type": "double" }, { - "description": "The template's name.", - "name": "templatename", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "Whether the template is enabled.", @@ -142284,13 +142670,6 @@ "isasync": true, "name": "addBaremetalDhcp", "params": [ - { - "description": "Type of dhcp device", - "length": 255, - "name": "dhcpservertype", - "required": true, - "type": "string" - }, { "description": "URL of the external dhcp appliance.", "length": 255, @@ -142306,32 +142685,44 @@ "type": "string" }, { - "description": "Credentials to reach external dhcp device", + "description": "the Physical Network ID", "length": 255, - "name": "password", + "name": "physicalnetworkid", + "related": "", + "required": true, + "type": "uuid" + }, + { + "description": "Type of dhcp device", + "length": 255, + "name": "dhcpservertype", "required": true, "type": "string" }, { - "description": "the Physical Network ID", + "description": "Credentials to reach external dhcp device", "length": 255, - "name": "physicalnetworkid", - "related": "", + "name": "password", "required": true, - "type": "uuid" + "type": "string" } ], "related": "listBaremetalDhcp", "response": [ + { + "description": "name of the provider", + "name": "dhcpservertype", + "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": "url", + "name": "url", + "type": "string" }, { "description": "device id of ", @@ -142339,14 +142730,9 @@ "type": "string" }, { - "description": "the physical network to which this external dhcp device belongs to", - "name": "physicalnetworkid", - "type": "string" - }, - { - "description": "url", - "name": "url", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "name of the provider", @@ -142354,8 +142740,8 @@ "type": "string" }, { - "description": "name of the provider", - "name": "dhcpservertype", + "description": "the physical network to which this external dhcp device belongs to", + "name": "physicalnetworkid", "type": "string" }, {}, @@ -142367,13 +142753,6 @@ "isasync": true, "name": "deleteTungstenFabricApplicationPolicySet", "params": [ - { - "description": "the uuid of Tungsten-Fabric application policy set", - "length": 255, - "name": "applicationpolicysetuuid", - "required": true, - "type": "string" - }, { "description": "the ID of zone", "length": 255, @@ -142381,31 +142760,38 @@ "related": "listZones", "required": true, "type": "uuid" + }, + { + "description": "the uuid of Tungsten-Fabric application policy set", + "length": 255, + "name": "applicationpolicysetuuid", + "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": "the current status of the latest 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" - }, - {} + } ] }, { @@ -142413,14 +142799,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, @@ -142437,6 +142815,22 @@ "required": true, "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, + "name": "destzoneids", + "related": "listZones", + "required": false, + "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": "This parameter enables the option the snapshot to be copied to supported primary storage", "length": 255, @@ -142453,22 +142847,14 @@ "required": false, "since": "4.21.0", "type": "list" - }, - { - "description": "A comma-separated list of IDs of the zones that the snapshot needs to be copied to. Specify this list if the snapshot needs to copied to multiple zones in one go. Do not specify destzoneid and destzoneids together, however one of them is required.", - "length": 255, - "name": "destzoneids", - "related": "listZones", - "required": false, - "type": "list" } ], "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", @@ -142476,81 +142862,18 @@ "type": "string" }, { - "description": "path of the Domain the snapshot's account belongs to", - "name": "domainpath", - "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": "indicates whether the underlying storage supports reverting the volume to this snapshot", + "name": "revertable", + "type": "boolean" }, { - "description": "type of the disk volume", - "name": "volumetype", + "description": "the project id of the snapshot", + "name": "projectid", "type": "string" }, - {}, { - "description": "the account associated with the snapshot", - "name": "account", + "description": "ID of the disk volume", + "name": "volumeid", "type": "string" }, { @@ -142559,65 +142882,65 @@ "type": "string" }, { - "description": "physical size of backedup snapshot on image store", - "name": "physicalsize", + "description": "virtual size of backedup snapshot on image store", + "name": "virtualsize", "type": "long" }, { - "description": "the project name of the snapshot", - "name": "project", + "description": "the domain ID of the snapshot's account", + "name": "domainid", "type": "string" }, { - "description": "name of the snapshot", - "name": "name", + "description": "name of the availability zone", + "name": "zonename", "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 snapshot", + "name": "account", + "type": "string" }, { - "description": "indicates whether the underlying storage supports reverting the volume to this snapshot", - "name": "revertable", - "type": "boolean" + "description": "the domain name of the snapshot's account", + "name": "domain", + "type": "string" }, { - "description": "the project id of the snapshot", - "name": "projectid", + "description": "state of the disk volume", + "name": "volumestate", "type": "string" }, { - "description": "valid location types are primary and secondary.", - "name": "locationtype", + "description": "id of the os on volume", + "name": "ostypeid", "type": "string" }, + {}, { - "description": "virtual size of backedup snapshot on image store", - "name": "virtualsize", + "description": "chain size of snapshot including all parent snapshots. Shown only for incremental snapshots if snapshot.show.chain.size setting is set to true", + "name": "chainsize", "type": "long" }, { - "description": " 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 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 snapshot", + "name": "name", + "type": "string" }, { - "description": "the domain ID of the snapshot's account", - "name": "domainid", + "description": "valid location types are primary and secondary.", + "name": "locationtype", "type": "string" }, { - "description": "the domain name of the snapshot's account", - "name": "domain", - "type": "string" + "description": "physical size of backedup snapshot on image store", + "name": "physicalsize", + "type": "long" }, { "description": "the type of the snapshot", @@ -142625,23 +142948,86 @@ "type": "string" }, { - "description": "ID of the datastore for the snapshot entry", - "name": "datastoreid", - "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 status of the template", - "name": "status", + "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": "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": "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": "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" + } + ], + "type": "set" + }, + { + "description": "type of the disk volume", + "name": "volumetype", "type": "string" }, { - "description": "ID of the disk volume", - "name": "volumeid", + "description": "name of the disk volume", + "name": "volumename", "type": "string" }, + {}, { - "description": "name of the datastore for the snapshot entry", - "name": "datastorename", + "description": "valid types are hourly, daily, weekly, monthy, template, and none.", + "name": "intervaltype", "type": "string" }, { @@ -142650,43 +143036,38 @@ "type": "boolean" }, { - "description": "name of the disk volume", - "name": "volumename", - "type": "string" - }, - { - "description": "type of the datastore for the snapshot entry", - "name": "datastoretype", + "description": "the project name of the snapshot", + "name": "project", "type": "string" }, { - "description": "state of the disk volume", - "name": "volumestate", + "description": "display name of the os on volume", + "name": "osdisplayname", "type": "string" }, { - "description": "state of the snapshot on the datastore", - "name": "datastorestate", + "description": "type of the datastore for the snapshot entry", + "name": "datastoretype", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "name of the datastore for the snapshot entry", + "name": "datastorename", "type": "string" }, { - "description": "id of the os on volume", - "name": "ostypeid", + "description": "path of the Domain the snapshot's account belongs to", + "name": "domainpath", "type": "string" }, { - "description": "valid types are hourly, daily, weekly, monthy, template, and none.", - "name": "intervaltype", + "description": "ID of the datastore for the snapshot entry", + "name": "datastoreid", "type": "string" }, { - "description": "display name of the os on volume", - "name": "osdisplayname", + "description": "state of the snapshot on the datastore", + "name": "datastorestate", "type": "string" }, { @@ -142695,8 +143076,13 @@ "type": "map" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the status of the template", + "name": "status", "type": "string" } ], @@ -142708,18 +143094,19 @@ "name": "addTrafficMonitor", "params": [ { - "description": "Traffic going into the listed zones will not be metered", + "description": "URL of the traffic monitor Host", "length": 255, - "name": "excludezones", - "required": false, + "name": "url", + "required": true, "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,51 +143116,50 @@ "type": "string" }, { - "description": "Zone in which to add the external firewall appliance.", + "description": "Traffic going into the listed zones will not be metered", "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, - "type": "uuid" + "name": "excludezones", + "required": false, + "type": "string" } ], "related": "", "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "the number of times to retry requests to the external firewall", "name": "numretries", "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 management IP address of the external firewall", - "name": "ipaddress", + "description": "the zone ID of the external firewall", + "name": "zoneid", "type": "string" }, { - "description": "the ID of the external firewall", - "name": "id", + "description": "the timeout (in seconds) for requests to the external firewall", + "name": "timeout", "type": "string" }, { - "description": "the timeout (in seconds) for requests to the external firewall", - "name": "timeout", + "description": "the management IP address of the external firewall", + "name": "ipaddress", "type": "string" }, - {}, { - "description": "the zone ID of the external firewall", - "name": "zoneid", + "description": "the ID of the external firewall", + "name": "id", "type": "string" } ] @@ -142784,139 +143170,129 @@ "name": "listUsers", "params": [ { - "description": "List users by state of the user account.", + "description": "List users by the Api key access value", "length": 255, - "name": "state", + "name": "apikeyaccess", "required": false, + "since": "4.20.1.0", "type": "string" }, { - "description": "", + "description": "List users by account type. Valid types include admin, domain-admin, read-only-admin, or user.", "length": 255, - "name": "page", + "name": "accounttype", "required": false, "type": "integer" }, { - "description": "flag to display the resource icon for users", + "description": "List by keyword", "length": 255, - "name": "showicon", + "name": "keyword", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "List by keyword", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "keyword", + "name": "listall", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "List users by the Api key access value", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "apikeyaccess", + "name": "account", "required": false, - "since": "4.20.1.0", "type": "string" }, { - "description": "List user by ID.", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "id", - "related": "disableUser,getUser,listUsers", + "name": "isrecursive", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "flag to display the resource icon for users", "length": 255, - "name": "account", + "name": "showicon", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "List user by the username", "length": 255, - "name": "listall", + "name": "username", "required": false, - "type": "boolean" + "type": "string" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "list only resources belonging to the domain specified", + "description": "List users by state of the user account.", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "state", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "List users by account type. Valid types include admin, domain-admin, read-only-admin, or user.", + "description": "", "length": 255, - "name": "accounttype", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "List user by ID.", "length": 255, - "name": "isrecursive", + "name": "id", + "related": "disableUser,getUser,listUsers", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "List users by their authentication source. Valid values are: native, ldap, saml2 and saml2disabled.", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "usersource", + "name": "domainid", + "related": "listDomains", "required": false, - "since": "4.21.0.0", - "type": "string" + "type": "uuid" }, { - "description": "List user by the username", + "description": "List users by their authentication source. Valid values are: native, ldap, saml2 and saml2disabled.", "length": 255, - "name": "username", + "name": "usersource", "required": false, + "since": "4.21.0.0", "type": "string" } ], "related": "disableUser,getUser", "response": [ { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the user name", - "name": "username", - "type": "string" - }, - { - "description": "the domain name of the user", - "name": "domain", + "description": "the account name of the user", + "name": "account", "type": "string" }, { - "description": "the secret key of the user", - "name": "secretkey", - "type": "string" + "description": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "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 date and time the user account was created", @@ -142924,19 +143300,8 @@ "type": "date" }, { - "description": "the timezone user was created in", - "name": "timezone", - "type": "string" - }, - {}, - { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", - "type": "string" - }, - { - "description": "the type of the role", - "name": "roletype", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -142945,48 +143310,48 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the user ID", + "name": "id", "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 name of the user", - "name": "account", - "type": "string" + "description": "true if user has two factor authentication enabled", + "name": "is2faenabled", + "type": "boolean" }, { - "description": "the user lastname", - "name": "lastname", + "description": "the timezone user was created in", + "name": "timezone", "type": "string" }, { - "description": "the user ID", - "name": "id", + "description": "the user state", + "name": "state", "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 ID of the role", + "name": "roleid", "type": "string" }, { - "description": "the domain ID of the user", - "name": "domainid", + "description": "the user lastname", + "name": "lastname", "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" }, { @@ -142995,9 +143360,9 @@ "type": "string" }, { - "description": "the user email address", - "name": "email", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { "description": "true if user has two factor authentication is mandated", @@ -143005,26 +143370,47 @@ "type": "boolean" }, { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", + "type": "string" + }, + { + "description": "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 domain ID of the user", + "name": "domainid", + "type": "string" }, {}, { - "description": "the ID of the role", - "name": "roleid", + "description": "the user firstname", + "name": "firstname", "type": "string" }, { - "description": "the user state", - "name": "state", + "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 type of the role", + "name": "roletype", + "type": "string" + }, + { + "description": "the user email address", + "name": "email", + "type": "string" + }, + {} ] }, { @@ -143033,16 +143419,9 @@ "name": "updateVlanIpRange", "params": [ { - "description": "the ending IPv6 address in the IPv6 network range", - "length": 255, - "name": "endipv6", - "required": false, - "type": "string" - }, - { - "description": "the gateway of the IPv6 network", + "description": "the ending IP address in the VLAN IP range", "length": 255, - "name": "ip6gateway", + "name": "endip", "required": false, "type": "string" }, @@ -143054,24 +143433,23 @@ "type": "boolean" }, { - "description": "the ending IP address in the VLAN IP range", + "description": "the beginning IPv6 address in the IPv6 network range", "length": 255, - "name": "endip", + "name": "startipv6", "required": false, "type": "string" }, { - "description": "the UUID of the VLAN IP range", + "description": "the gateway of the VLAN IP range", "length": 255, - "name": "id", - "related": "updateVlanIpRange", - "required": true, - "type": "uuid" + "name": "gateway", + "required": false, + "type": "string" }, { - "description": "the netmask of the VLAN IP range", + "description": "the gateway of the IPv6 network", "length": 255, - "name": "netmask", + "name": "ip6gateway", "required": false, "type": "string" }, @@ -143083,18 +143461,19 @@ "type": "string" }, { - "description": "the gateway of the VLAN IP range", + "description": "the netmask of the VLAN IP range", "length": 255, - "name": "gateway", + "name": "netmask", "required": false, "type": "string" }, { - "description": "the beginning IPv6 address in the IPv6 network range", + "description": "the UUID of the VLAN IP range", "length": 255, - "name": "startipv6", - "required": false, - "type": "string" + "name": "id", + "related": "updateVlanIpRange", + "required": true, + "type": "uuid" }, { "description": "the beginning IP address in the VLAN IP range", @@ -143102,114 +143481,112 @@ "name": "startip", "required": false, "type": "string" + }, + { + "description": "the ending IPv6 address in the IPv6 network range", + "length": 255, + "name": "endipv6", + "required": false, + "type": "string" } ], "related": "", "response": [ + {}, { - "description": "the domain name of the VLAN IP range", - "name": "domain", + "description": "the Zone ID of the VLAN IP range", + "name": "zoneid", "type": "string" }, { - "description": "the network id of vlan range", - "name": "networkid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "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", + "description": "the account of the VLAN IP range", + "name": "account", "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "the Pod name for the VLAN IP range", + "name": "podname", "type": "string" }, { - "description": "the Zone ID of the VLAN IP range", - "name": "zoneid", + "description": "the netmask of the VLAN IP range", + "name": "netmask", "type": "string" }, { - "description": "the end ip of the VLAN IP range", - "name": "endip", - "type": "string" + "description": "indicates whether VLAN IP range is dedicated to system vms or not", + "name": "forsystemvms", + "type": "boolean" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the domain name of the VLAN IP range", + "name": "domain", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the ID of the VLAN IP range", - "name": "id", + "description": "the end ip of the VLAN IP range", + "name": "endip", "type": "string" }, { - "description": "the description of the VLAN IP range", - "name": "description", + "description": "the project id of the vlan range", + "name": "projectid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the ID or VID of the VLAN.", - "name": "vlan", + "description": "the start ipv6 of the VLAN IP range", + "name": "startipv6", "type": "string" }, { - "description": "path of the domain to which the VLAN IP range belongs", - "name": "domainpath", + "description": "the start ip of the VLAN IP range", + "name": "startip", "type": "string" }, { - "description": "the account of the VLAN IP range", - "name": "account", + "description": "indicates to which provider the IP range is dedicated to", + "name": "provider", "type": "string" }, - {}, { - "description": "the Pod name for the VLAN IP range", - "name": "podname", + "description": "the Pod ID for the VLAN IP range", + "name": "podid", "type": "string" }, { - "description": "the domain ID of the VLAN IP range", - "name": "domainid", + "description": "the gateway of the VLAN IP range", + "name": "gateway", "type": "string" }, { - "description": "the 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 end ipv6 of the VLAN IP range", + "name": "endipv6", "type": "string" }, + {}, { - "description": "the end ipv6 of the VLAN IP range", - "name": "endipv6", + "description": "path of the domain to which the VLAN IP range belongs", + "name": "domainpath", "type": "string" }, { - "description": "indicates to which provider the IP range is dedicated to", - "name": "provider", + "description": "the ID of the VLAN IP range", + "name": "id", "type": "string" }, { @@ -143217,35 +143594,44 @@ "name": "forvirtualnetwork", "type": "boolean" }, - {}, { - "description": "the project id of the vlan range", - "name": "projectid", + "description": "the cidr of the VLAN IP range", + "name": "cidr", "type": "string" }, { - "description": "the project name of the vlan range", - "name": "project", + "description": "the ID or VID of the VLAN.", + "name": "vlan", + "type": "string" + }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the gateway of the VLAN IP range", - "name": "gateway", + "description": "the domain ID of the VLAN IP range", + "name": "domainid", "type": "string" }, { - "description": "the netmask of the VLAN IP range", - "name": "netmask", + "description": "the network id of vlan range", + "name": "networkid", "type": "string" }, { - "description": "the start ip of the VLAN IP range", - "name": "startip", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the Pod ID for the VLAN IP range", - "name": "podid", + "description": "the project name of the vlan range", + "name": "project", "type": "string" } ], @@ -143257,12 +143643,11 @@ "name": "listResourceLimits", "params": [ { - "description": "list only resources belonging to the domain specified", + "description": "Lists resource limits by ID.", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "id", "required": false, - "type": "uuid" + "type": "long" }, { "description": "", @@ -143272,19 +143657,18 @@ "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": "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": "listall", + "name": "resourcetypename", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "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": "projectid", - "related": "", + "name": "resourcetype", "required": false, - "type": "uuid" + "type": "integer" }, { "description": "List by keyword", @@ -143294,24 +143678,25 @@ "type": "string" }, { - "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": "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": "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": "Tag for the resource type", "length": 255, - "name": "resourcetypename", + "name": "tag", "required": false, + "since": "4.20.0", "type": "string" }, { @@ -143322,45 +143707,39 @@ "type": "integer" }, { - "description": "Tag for the resource type", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "tag", + "name": "account", "required": false, - "since": "4.20.0", "type": "string" }, { - "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 only resources belonging to the domain specified", "length": 255, - "name": "id", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "long" + "type": "uuid" } ], "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", - "type": "string" - }, - { - "description": "The tag for the resource limit", - "name": "tag", + "description": "the account of the resource limit", + "name": "account", "type": "string" }, - {}, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "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" }, { @@ -143368,36 +143747,33 @@ "name": "project", "type": "string" }, + {}, { - "description": "the account of the resource limit", - "name": "account", + "description": "the project id of the resource limit", + "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", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the maximum number of the resource. A -1 means the resource currently has no limit.", "name": "max", "type": "long" }, + {}, { - "description": "the domain ID of the resource limit", - "name": "domainid", + "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 project id of the resource limit", - "name": "projectid", + "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": "path of the domain to which the resource limit belongs", "name": "domainpath", @@ -143407,6 +143783,16 @@ "description": "the domain name of the resource limit", "name": "domain", "type": "string" + }, + { + "description": "The tag for the resource limit", + "name": "tag", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ] }, @@ -143427,18 +143813,18 @@ "related": "getUser", "response": [ { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" + "description": "the account ID of the user", + "name": "accountid", + "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", - "type": "string" + "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", + "name": "apikeyaccess", + "type": "apikeyaccess" }, { - "description": "the 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" }, { @@ -143452,29 +143838,34 @@ "type": "string" }, { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", + "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 api key of the user", - "name": "apikey", - "type": "string" + "description": "true if user has two factor authentication enabled", + "name": "is2faenabled", + "type": "boolean" }, { - "description": "the user firstname", - "name": "firstname", + "description": "the user email address", + "name": "email", "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": "the account type of the user", + "name": "accounttype", + "type": "integer" }, { "description": "the user ID", @@ -143482,61 +143873,56 @@ "type": "string" }, { - "description": "the domain ID of the user", - "name": "domainid", + "description": "the user firstname", + "name": "firstname", "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 user lastname", + "name": "lastname", "type": "string" }, { - "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 email address", - "name": "email", + "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 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 api key of the user", + "name": "apikey", + "type": "string" }, { - "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": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { "description": "the current status of the latest async job acting on this object", @@ -143544,23 +143930,23 @@ "type": "integer" }, { - "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 type of the role", - "name": "roletype", - "type": "string" + "description": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the domain name of the user", - "name": "domain", + "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 user state", + "name": "state", "type": "string" } ] @@ -143571,25 +143957,23 @@ "name": "listIsos", "params": [ { - "description": "the ID of the OS category for the ISO", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "oscategoryid", - "related": "listOsCategories", + "name": "isrecursive", "required": false, - "since": "4.21.0", - "type": "uuid" + "type": "boolean" }, { - "description": "list ISOs that are ready to be deployed", + "description": "flag to display the resource image for the isos", "length": 255, - "name": "isready", + "name": "showicon", "required": false, "type": "boolean" }, { - "description": "the hypervisor for which to restrict the search", + "description": "list all ISOs by name", "length": 255, - "name": "hypervisor", + "name": "name", "required": false, "type": "string" }, @@ -143601,32 +143985,17 @@ "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, - "name": "isrecursive", - "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": "listDomains", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "list ISO by ID", "length": 255, - "name": "projectid", - "related": "", + "name": "id", + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", "required": false, "type": "uuid" }, @@ -143648,36 +144017,42 @@ "type": "string" }, { - "description": "the ID of the 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": "If set to true, list only unique isos across zones", + "description": "list ISOs that are ready to be deployed", "length": 255, - "name": "showunique", + "name": "isready", "required": false, - "since": "4.13.2", "type": "boolean" }, { - "description": "ID of the storage pool", + "description": "the ID of the OS category for the ISO", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", + "name": "oscategoryid", + "related": "listOsCategories", "required": false, - "since": "4.19", + "since": "4.21.0", "type": "uuid" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "true if the ISO is publicly available to all users, false otherwise.", "length": 255, - "name": "account", + "name": "ispublic", "required": false, - "type": "string" + "type": "boolean" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { "description": "show removed ISOs as well", @@ -143687,17 +144062,24 @@ "type": "boolean" }, { - "description": "List resources by tags (key/value pairs)", + "description": "true if the ISO is bootable, false otherwise", "length": 255, - "name": "tags", + "name": "bootable", "required": false, - "type": "map" + "type": "boolean" }, { - "description": "list ISO by ID", + "description": "", "length": 255, - "name": "id", - "related": "listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "the ID of the zone", + "length": 255, + "name": "zoneid", + "related": "listZones", "required": false, "type": "uuid" }, @@ -143709,102 +144091,173 @@ "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": "If set to true, list only unique isos across zones", "length": 255, - "name": "listall", + "name": "showunique", "required": false, + "since": "4.13.2", "type": "boolean" }, { - "description": "flag to display the resource image for the isos", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "showicon", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "true if the ISO is bootable, false otherwise", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "bootable", + "name": "tags", "required": false, - "type": "boolean" + "type": "map" }, { - "description": "list all ISOs by name", + "description": "ID of the storage pool", "length": 255, - "name": "name", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", "required": false, - "type": "string" + "since": "4.19", + "type": "uuid" }, { - "description": "true if the ISO is publicly available to all users, false otherwise.", + "description": "the hypervisor for which to restrict the search", "length": 255, - "name": "ispublic", + "name": "hypervisor", "required": false, - "type": "boolean" + "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": "pagesize", + "name": "listall", "required": false, - "type": "integer" + "type": "boolean" } ], - "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", + "description": "the name of the secondary storage host for the template", + "name": "hostname", "type": "string" }, { - "description": "the name of the OS type for this template.", - "name": "ostypename", + "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", + "name": "deployasis", + "type": "boolean" + }, + { + "description": "the template display text", + "name": "displaytext", "type": "string" }, { - "description": "the project id of the template", - "name": "projectid", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the template ID", - "name": "id", + "description": "the physical size of the template", + "name": "physicalsize", + "type": "long" + }, + { + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", + "type": "boolean" + }, + { + "description": "The name of extension linked to this template", + "name": "extensionname", "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", + "type": "string" }, { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", + "description": "the name of userdata linked to this template", + "name": "userdataname", + "type": "string" + }, + { + "description": "the ID of the zone for this template", + "name": "zoneid", + "type": "string" + }, + { + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", "type": "boolean" }, + { + "description": "the processor bit size", + "name": "bits", + "type": "int" + }, + { + "description": "the template name", + "name": "name", + "type": "string" + }, + { + "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": "the template ID of the parent template if present", + "name": "sourcetemplateid", + "type": "string" + }, + { + "description": "the account id to which the template belongs", + "name": "accountid", + "type": "string" + }, + { + "description": "CPU Arch of the template", + "name": "arch", + "type": "string" + }, + {}, { "description": "checksum of the template", "name": "checksum", "type": "string" }, + {}, + { + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", + "type": "boolean" + }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "resource type", - "name": "resourcetype", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -143813,107 +144266,102 @@ "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the 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 account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" } ], "type": "set" }, { - "description": "the name of userdata linked to this template", - "name": "userdataname", + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", + "type": "boolean" + }, + { + "description": "the ID of the secondary storage host for the template", + "name": "hostid", "type": "string" }, { - "description": "the physical size of the template", - "name": "physicalsize", - "type": "long" + "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": "If true it indicates that the template can be used for CKS cluster deployments", + "name": "forcks", + "type": "boolean" }, { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", - "type": "string" + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", + "type": "boolean" }, + {}, { - "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": "additional key/value details tied with template", + "name": "details", + "type": "map" + }, { "description": "the date this template was created", "name": "created", "type": "date" }, { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", - "type": "boolean" - }, - { - "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", - "name": "deployasis", - "type": "boolean" - }, - { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", + "description": "the template ID", + "name": "id", "type": "string" }, { - "description": "If true it indicates that the template can be used for CKS cluster deployments", - "name": "forcks", - "type": "boolean" - }, - { - "description": "the account id to which the template belongs", - "name": "accountid", + "description": "The ID of extension linked to this template", + "name": "extensionid", "type": "string" }, { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" + "description": "the project id of the template", + "name": "projectid", + "type": "string" }, { - "description": "CPU Arch of the template", - "name": "arch", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -143922,28 +144370,23 @@ "type": "boolean" }, { - "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 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 URL which the template/iso is registered from", + "name": "url", "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", + "description": "the name of the domain to which the template belongs", + "name": "domain", "type": "string" }, { @@ -143952,124 +144395,84 @@ "type": "string" }, { - "description": "path of the Domain the template belongs to", - "name": "domainpath", + "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", - "type": "boolean" - }, - { - "description": "the id of userdata linked to this template", - "name": "userdataid", + "description": "the tag of this template", + "name": "templatetag", "type": "string" }, { - "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" }, { - "description": "the name of the secondary storage host for the template", - "name": "hostname", + "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": "the format of the template.", + "name": "format", + "type": "imageformat" }, { "description": "the name of the zone for this template", "name": "zonename", "type": "string" }, - { - "description": "the ID of the zone for this template", - "name": "zoneid", - "type": "string" - }, { "description": "Base64 string representation of the resource icon", "name": "icon", "type": "resourceiconresponse" }, { - "description": "the type of the template", - "name": "templatetype", - "type": "string" - }, - { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", - "type": "boolean" - }, - { - "description": "the date this template was removed", - "name": "removed", - "type": "date" - }, - { - "description": "the processor bit size", - "name": "bits", - "type": "int" - }, - { - "description": "the name of the domain to which the template belongs", - "name": "domain", + "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": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", - "type": "boolean" - }, - { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", + "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 status of the template", + "name": "status", "type": "string" }, { - "description": "the tag of this template", - "name": "templatetag", + "description": "the account name to which the template belongs", + "name": "account", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" }, { - "description": "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": "the ID of the secondary storage host for the template", - "name": "hostid", - "type": "string" + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", + "type": "boolean" }, { - "description": "the template display text", - "name": "displaytext", + "description": "path of the Domain the template belongs to", + "name": "domainpath", "type": "string" }, { - "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 size of the template", @@ -144077,36 +144480,19 @@ "type": "long" }, { - "description": "the URL which the template/iso is registered from", - "name": "url", - "type": "string" - }, - {}, - { - "description": "the project name of the template", - "name": "project", - "type": "string" - }, - { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" - }, - { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, - {}, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "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", - "type": "string" + "description": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" } ] }, @@ -144115,35 +144501,6 @@ "isasync": false, "name": "listAutoScalePolicies", "params": [ - { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, - { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", - "length": 255, - "name": "isrecursive", - "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": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, { "description": "the ID of the autoscale vm group", "length": 255, @@ -144159,13 +144516,6 @@ "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, @@ -144181,6 +144531,20 @@ "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": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, { "description": "list only resources belonging to the domain specified", "length": 255, @@ -144190,12 +144554,11 @@ "type": "uuid" }, { - "description": "the name of the autoscale policy", + "description": "", "length": 255, - "name": "name", + "name": "pagesize", "required": false, - "since": "4.18.0", - "type": "string" + "type": "integer" }, { "description": "the action to be executed if all the conditions evaluate to true for the specified duration.", @@ -144211,34 +144574,68 @@ "related": "listAutoScalePolicies", "required": false, "type": "uuid" + }, + { + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "length": 255, + "name": "isrecursive", + "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 name of the autoscale policy", + "length": 255, + "name": "name", + "required": false, + "since": "4.18.0", + "type": "string" } ], "related": "", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the cool down period for which the policy should not be evaluated after the action has been taken", + "name": "quiettime", + "type": "integer" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the autoscale policy ID", + "name": "id", + "type": "string" }, { - "description": "the duration for which the conditions have to be true before action is taken", - "name": "duration", - "type": "integer" + "description": "the account owning the autoscale policy", + "name": "account", + "type": "string" }, { - "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 project name of the autoscale policy", - "name": "project", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the domain ID of the autoscale policy", + "name": "domainid", + "type": "string" + }, + { + "description": "the project id autoscale policy", + "name": "projectid", "type": "string" }, { @@ -144247,8 +144644,8 @@ "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 duration for which the conditions have to be true before action is taken", + "name": "duration", "type": "integer" }, { @@ -144257,35 +144654,24 @@ "type": "list" }, { - "description": "the account owning the autoscale policy", - "name": "account", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "path of the domain to which the autoscale policy belongs", - "name": "domainpath", + "description": "name of the autoscale policy", + "name": "name", "type": "string" }, { - "description": "the domain ID of the autoscale policy", - "name": "domainid", + "description": "the project name of the autoscale policy", + "name": "project", "type": "string" }, - {}, { "description": "the 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", - "type": "string" } ] }, @@ -144294,13 +144680,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, @@ -144309,14 +144688,6 @@ "required": false, "type": "uuid" }, - { - "description": "domain ID of the account owning the IPv4 subnet", - "length": 255, - "name": "domainid", - "related": "listDomains", - "required": false, - "type": "uuid" - }, { "description": "Id of the guest network IPv4 subnet", "length": 255, @@ -144324,35 +144695,36 @@ "related": "dedicateIpv4SubnetForZone", "required": true, "type": "uuid" - } - ], - "related": "", - "response": [ - { - "description": "the domain name of the IPv4 subnet", - "name": "domain", - "type": "string" - }, - { - "description": "date when this IPv4 subnet was created.", - "name": "created", - "type": "date" }, { - "description": "the project name of the IPv4 subnet", - "name": "project", + "description": "account who will own the IPv4 subnet", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "the account of the IPv4 subnet", - "name": "account", + "description": "domain ID of the account owning the IPv4 subnet", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" + } + ], + "related": "", + "response": [ + { + "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 domain ID of the IPv4 subnet", + "name": "domainid", "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -144364,16 +144736,20 @@ "type": "string" }, { - "description": "name of zone to which the IPv4 subnet belongs to.", - "name": "zonename", + "description": "date when this IPv4 subnet was created.", + "name": "created", + "type": "date" + }, + { + "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", + "description": "the project name of the IPv4 subnet", + "name": "project", "type": "string" }, - {}, { "description": "id of the guest IPv4 subnet", "name": "id", @@ -144386,80 +144762,28 @@ }, {}, { - "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": "url", - "name": "url", - "type": "string" - }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } - ] - }, - { - "description": "List Shared FileSystems", - "isasync": false, - "name": "listSharedFileSystems", - "params": [ - { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, + "description": "the account of the IPv4 subnet", "name": "account", - "required": false, "type": "string" }, { - "description": "the ID of the network", - "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", - "required": false, - "type": "uuid" - }, - { - "description": "the ID of the availability zone", - "length": 255, + "description": "id of zone to which the IPv4 subnet belongs to.", "name": "zoneid", - "related": "listZones", - "required": false, - "type": "uuid" + "type": "string" }, + { + "description": "the domain name of the IPv4 subnet", + "name": "domain", + "type": "string" + } + ], + "since": "4.20.0" + }, + { + "description": "List Shared FileSystems", + "isasync": false, + "name": "listSharedFileSystems", + "params": [ { "description": "list only resources belonging to the domain specified", "length": 255, @@ -144471,30 +144795,40 @@ { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "makes the API's response contains only the resource count", + "description": "the ID of the network", "length": 255, - "name": "retrieveonlyresourcecount", + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "List by keyword", + "description": "the service offering of the shared filesystem", "length": 255, - "name": "keyword", + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "", + "description": "the ID of the availability zone", "length": 255, - "name": "pagesize", + "name": "zoneid", + "related": "listZones", "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. Resources dedicated to a project are listed only if using the projectid parameter.", + "length": 255, + "name": "listall", + "required": false, + "type": "boolean" }, { "description": "the name of the shared filesystem", @@ -144512,12 +144846,11 @@ "type": "uuid" }, { - "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 shared filesystem", @@ -144528,26 +144861,26 @@ "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": "makes the API's response contains only the resource count", "length": 255, - "name": "listall", + "name": "retrieveonlyresourcecount", "required": false, "type": "boolean" }, { - "description": "the service offering of the shared filesystem", + "description": "List by keyword", "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", + "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 objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "isrecursive", + "name": "projectid", + "related": "", "required": false, - "type": "boolean" + "type": "uuid" }, { "description": "List resources by tags (key/value pairs)", @@ -144555,34 +144888,32 @@ "name": "tags", "required": false, "type": "map" - } - ], - "related": "changeSharedFileSystemDiskOffering", - "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" }, { - "description": "the shared filesystem provider", - "name": "provider", - "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": "path to mount the shared filesystem", - "name": "path", + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, "type": "string" - }, + } + ], + "related": "changeSharedFileSystemDiskOffering", + "response": [ { - "description": "the disk utilization", - "name": "utilization", + "description": "service offering for the shared filesystem", + "name": "serviceofferingname", "type": "string" }, - {}, { - "description": "name of the storage pool hosting the data volume", - "name": "storage", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -144590,18 +144921,18 @@ "name": "nic", "response": [ { - "description": "the type of the nic", - "name": "type", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "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": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { @@ -144610,14 +144941,29 @@ "type": "list" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" + "description": "the type of the nic", + "name": "type", + "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": "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", @@ -144625,29 +144971,29 @@ "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the netmask of the nic", + "name": "netmask", "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": "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 Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" }, { "description": "the IPv6 address of network", @@ -144655,38 +145001,53 @@ "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "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": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { @@ -144695,289 +145056,275 @@ "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", "type": "integer" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the project name where tag belongs to", + "name": "project", "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 isolation uri of the nic", - "name": "isolationuri", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" } ], - "type": "list" + "type": "set" }, { - "description": "the shared filesystem's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "the state of the shared filesystem", + "name": "state", + "type": "string" }, { - "description": "the bytes actually consumed on disk", - "name": "physicalsize", - "type": "long" + "description": "size of the shared filesystem in GiB", + "name": "sizegb", + "type": "string" }, + {}, { - "description": "the bytes allocated", - "name": "virtualsize", + "description": "the shared filesystem's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { - "description": "ID of the storage pool hosting the data volume", - "name": "storageid", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "service offering for the shared filesystem", - "name": "serviceofferingname", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "ID of the storage fs vm", - "name": "vmstate", + "description": "ID of the storage pool hosting the data volume", + "name": "storageid", "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", + "type": "string" }, { - "description": "ID of the shared filesystem", - "name": "id", + "description": "description of the shared filesystem", + "name": "description", "type": "string" }, { - "description": "service offering ID for the shared filesystem", - "name": "serviceofferingid", + "description": "ID of the storage fs vm", + "name": "virtualmachineid", "type": "string" }, { - "description": "Network name of the shared filesystem", - "name": "networkname", - "type": "string" + "description": "disk offering for the shared filesystem has custom size", + "name": "iscustomdiskoffering", + "type": "boolean" }, { - "description": "ID of the storage fs data volume", - "name": "volumeid", + "description": "Network name of the shared filesystem", + "name": "networkname", "type": "string" }, { - "description": "the state of the shared filesystem", - "name": "state", + "description": "disk offering for the shared filesystem", + "name": "diskofferingname", "type": "string" }, { - "description": "the account associated with the shared filesystem", - "name": "account", - "type": "string" + "description": "the bytes actually consumed on disk", + "name": "physicalsize", + "type": "long" }, { - "description": "disk offering display text for the shared filesystem", - "name": "diskofferingdisplaytext", + "description": "provisioning type used in the shared filesystem", + "name": "provisioningtype", "type": "string" }, { - "description": "path of the domain to which the shared filesystem", - "name": "domainpath", + "description": "Network ID of the shared filesystem", + "name": "networkid", "type": "string" }, { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "the shared filesystem provider", + "name": "provider", "type": "string" }, { - "description": "the domain associated with the shared filesystem", - "name": "domain", - "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 shared filesystem", "name": "diskiowrite", "type": "long" }, + {}, { - "description": "name of the storage fs data volume", - "name": "volumename", - "type": "string" - }, - { - "description": "disk offering ID for the shared filesystem", - "name": "diskofferingid", + "description": "service offering ID for the shared filesystem", + "name": "serviceofferingid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the bytes allocated", + "name": "virtualsize", + "type": "long" }, { - "description": "ID of the storage fs vm", - "name": "virtualmachineid", + "description": "name of the shared filesystem", + "name": "name", "type": "string" }, { - "description": "name of the shared filesystem", - "name": "name", + "description": "name of the storage pool hosting the data volume", + "name": "storage", "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": "the ID of the domain associated with the shared filesystem", + "name": "domainid", "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", + "type": "string" }, { - "description": "provisioning type used in the shared filesystem", - "name": "provisioningtype", + "description": "ID of the shared filesystem", + "name": "id", "type": "string" }, { - "description": "the shared filesystem's disk read in KiB", - "name": "diskkbsread", + "description": "size of the shared filesystem", + "name": "size", "type": "long" }, { - "description": "disk offering for the shared filesystem", - "name": "diskofferingname", + "description": "disk offering ID for the shared filesystem", + "name": "diskofferingid", "type": "string" }, { - "description": "size of the shared filesystem in GiB", - "name": "sizegb", + "description": "ID of the storage fs vm", + "name": "vmstate", "type": "string" }, { - "description": "Network ID of the shared filesystem", - "name": "networkid", + "description": "name of the storage fs data volume", + "name": "volumename", "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": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - } - ], - "type": "set" + "description": "the project ID of the shared filesystem", + "name": "projectid", + "type": "string" }, { "description": "the filesystem format", "name": "filesystem", "type": "string" }, + { + "description": "the shared filesystem's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "the account associated with the shared filesystem", + "name": "account", + "type": "string" + }, + { + "description": "the domain associated with the shared filesystem", + "name": "domain", + "type": "string" + }, { "description": "Name of the availability zone", "name": "zonename", "type": "string" }, { - "description": "the project ID of the shared filesystem", - "name": "projectid", + "description": "ID of the storage fs data volume", + "name": "volumeid", "type": "string" }, { @@ -144986,18 +145333,57 @@ "type": "string" }, { - "description": "the ID of the domain associated with the shared filesystem", - "name": "domainid", + "description": "path to mount the shared filesystem", + "name": "path", "type": "string" }, { - "description": "size of the shared filesystem", - "name": "size", - "type": "long" + "description": "the disk utilization", + "name": "utilization", + "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 UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "url", + "name": "url", + "type": "string" + }, + {}, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ] + }, { "description": "Updates a role", "isasync": false, @@ -145011,16 +145397,24 @@ "type": "boolean" }, { - "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": "ID of the role", "length": 255, - "name": "type", + "name": "id", + "related": "listRoles,updateRole", + "required": true, + "type": "uuid" + }, + { + "description": "creates a role with this unique name", + "length": 255, + "name": "name", "required": false, "type": "string" }, @@ -145031,14 +145425,6 @@ "required": false, "type": "string" }, - { - "description": "ID of the role", - "length": 255, - "name": "id", - "related": "listRoles,updateRole", - "required": true, - "type": "uuid" - }, { "description": "The description of the role", "length": 255, @@ -145049,20 +145435,25 @@ ], "related": "listRoles", "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the description of the role", "name": "description", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the name of the role", + "name": "name", + "type": "string" }, { - "description": "the ID of the role", - "name": "id", - "type": "string" + "description": "Indicates whether the role will be visible to all users (public) or only to root admins (private). If this parameter is not specified during the creation of the role its value will be defaulted to true (public).", + "name": "ispublic", + "type": "boolean" }, { "description": "true if role is default, false otherwise", @@ -145070,32 +145461,27 @@ "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the type of the role", + "name": "type", "type": "string" }, { - "description": "the state of the role", - "name": "state", + "description": "the ID of the role", + "name": "id", "type": "string" }, - {}, { - "description": "the type of the role", - "name": "type", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the name of the role", - "name": "name", + "description": "the state of the role", + "name": "state", "type": "string" }, {}, - { - "description": "Indicates whether the role will be visible to all users (public) or only to root admins (private). If this parameter is not specified during the creation of the role its value will be defaulted to true (public).", - "name": "ispublic", - "type": "boolean" - } + {} ], "since": "4.9.0" }, @@ -145105,35 +145491,42 @@ "name": "listRemoteAccessVpns", "params": [ { - "description": "public ip address id of the vpn server", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "publicipid", - "related": "updateIpAddress,associateIpAddress,listPublicIpAddresses", + "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 remote access VPNs for certain network", "length": 255, - "name": "isrecursive", + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", "required": false, - "type": "boolean" + "since": "4.3", + "type": "uuid" }, { - "description": "Lists remote access vpn rule with the specified ID", + "description": "public ip address id of the vpn server", "length": 255, - "name": "id", - "related": "listRemoteAccessVpns", + "name": "publicipid", + "related": "updateIpAddress,associateIpAddress,listPublicIpAddresses", "required": false, - "since": "4.3", "type": "uuid" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "List by keyword", "length": 255, - "name": "listall", + "name": "keyword", "required": false, - "type": "boolean" + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { "description": "list objects by project; if projectid=-1 lists All VMs", @@ -145144,11 +145537,18 @@ "type": "uuid" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "account", + "name": "listall", "required": false, - "type": "string" + "type": "boolean" + }, + { + "description": "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", @@ -145161,84 +145561,68 @@ { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "list only resources belonging to the domain specified", - "length": 255, - "name": "domainid", - "related": "listDomains", - "required": false, - "type": "uuid" - }, - { - "description": "list remote access VPNs for certain network", + "description": "Lists remote access vpn rule with the specified ID", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", + "name": "id", + "related": "listRemoteAccessVpns", "required": false, "since": "4.3", "type": "uuid" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, - { - "description": "", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "pagesize", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "integer" + "type": "uuid" } ], "related": "", "response": [ { - "description": "the domain name of the account of the remote access vpn", - "name": "domain", + "description": "the range of ips to allocate to the clients", + "name": "iprange", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the public ip address of the vpn server", + "name": "publicip", "type": "string" }, { - "description": "the id of the remote access vpn", - "name": "id", + "description": "the domain id of the account of the remote access vpn", + "name": "domainid", "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", "type": "string" }, - {}, - {}, - { - "description": "is vpn for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, { - "description": "the domain id of the account of the remote access vpn", - "name": "domainid", + "description": "path of the domain to which the remote access vpn belongs", + "name": "domainpath", "type": "string" }, { - "description": "the ipsec preshared key", - "name": "presharedkey", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { - "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" }, { @@ -145247,13 +145631,19 @@ "type": "string" }, { - "description": "the range of ips to allocate to the clients", - "name": "iprange", + "description": "the ipsec preshared key", + "name": "presharedkey", "type": "string" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "is vpn for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + {}, + { + "description": "the id of the remote access vpn", + "name": "id", "type": "string" }, { @@ -145267,15 +145657,11 @@ "type": "string" }, { - "description": "the public ip address of the vpn server", - "name": "publicip", + "description": "the UUID of the latest async 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" - } + {} ] }, { @@ -145293,22 +145679,22 @@ } ], "response": [ - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, + {}, { "description": "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", @@ -145333,7 +145719,16 @@ } ], "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", @@ -145344,16 +145739,7 @@ "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" - }, + {}, {} ] }, @@ -145372,9 +145758,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" }, { @@ -145382,18 +145770,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" + } ] }, { @@ -145402,35 +145788,27 @@ "name": "createServiceInstance", "params": [ { - "description": "The right (outside) network ID for the service instance", + "description": "An optional domainId for the virtual machine. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "rightnetworkid", - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", - "required": true, + "name": "domainid", + "related": "listDomains", + "required": false, "type": "uuid" }, { - "description": "The name of the service instance", - "length": 255, - "name": "name", - "required": true, - "type": "string" - }, - { - "description": "Availability zone for the service instance", + "description": "The left (inside) network for service instance", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "leftnetworkid", + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", "required": true, "type": "uuid" }, { - "description": "The service offering ID that defines the resources consumed by the service appliance", + "description": "The name of the service instance", "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", + "name": "name", "required": true, - "type": "uuid" + "type": "string" }, { "description": "An optional account for the virtual machine. Must be used with domainId.", @@ -145439,14 +145817,6 @@ "required": false, "type": "string" }, - { - "description": "An optional domainId for the virtual machine. If the account parameter is used, domainId must also be used.", - "length": 255, - "name": "domainid", - "related": "listDomains", - "required": false, - "type": "uuid" - }, { "description": "Project ID for the service instance", "length": 255, @@ -145456,9 +145826,9 @@ "type": "uuid" }, { - "description": "The left (inside) network for service instance", + "description": "The right (outside) network ID for the service instance", "length": 255, - "name": "leftnetworkid", + "name": "rightnetworkid", "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", "required": true, "type": "uuid" @@ -145467,69 +145837,85 @@ "description": "The template ID that specifies the image for the service appliance", "length": 255, "name": "templateid", - "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", + "required": true, + "type": "uuid" + }, + { + "description": "Availability zone for the service instance", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" + }, + { + "description": "The service offering ID that defines the resources consumed by the service appliance", + "length": 255, + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", "required": true, "type": "uuid" } ], "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 domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, - {}, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "the ID of the virtual machine", + "name": "id", "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": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -145550,28 +145936,23 @@ "related": "", "response": [ { - "description": "the template name for the system VM", - "name": "templatename", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the host ID for the system VM", + "name": "hostid", "type": "string" }, { - "description": "guest vlan range", - "name": "guestvlan", + "description": "the template name for the system VM", + "name": "templatename", "type": "string" }, { - "description": "public vlan range", - "name": "publicvlan", - "type": "list" - }, - { - "description": "the gateway for the system VM", - "name": "gateway", + "description": "the ID of the service offering of the system virtual machine.", + "name": "serviceofferingid", "type": "string" }, { @@ -145580,18 +145961,18 @@ "type": "date" }, { - "description": "the state of the system VM", - "name": "state", + "description": "the Pod name for the system VM", + "name": "podname", "type": "string" }, { - "description": "CPU arch of the system VM", - "name": "arch", + "description": "the state of the system VM", + "name": "state", "type": "string" }, { - "description": "the hostname for the system VM", - "name": "hostname", + "description": "the Pod ID for the system VM", + "name": "podid", "type": "string" }, { @@ -145600,162 +145981,167 @@ "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 public IP address for the system VM", - "name": "publicip", + "description": "the Zone ID for the system VM", + "name": "zoneid", "type": "string" }, { - "description": "the host ID for the system VM", - "name": "hostid", + "description": "the systemvm agent version", + "name": "version", "type": "string" }, { - "description": "the agent state of the system VM", - "name": "agentstate", + "description": "the first DNS for the system VM", + "name": "dns1", "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": "the control state of the host for the system VM", + "name": "hostcontrolstate", + "type": "string" }, { - "description": "the ID of the system VM", - "name": "id", - "type": "string" + "description": "public vlan range", + "name": "publicvlan", + "type": "list" }, { - "description": "the Pod ID for the system VM", - "name": "podid", + "description": "the name of the system VM", + "name": "name", "type": "string" }, { - "description": "the private MAC address for the system VM", - "name": "privatemacaddress", + "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", + "description": "the name of the service offering of the system virtual machine.", + "name": "serviceofferingname", "type": "string" }, { - "description": "the Zone ID for the system VM", - "name": "zoneid", + "description": "the ID of the system VM", + "name": "id", "type": "string" }, { - "description": "the systemvm agent version", - "name": "version", + "description": "the gateway for the system VM", + "name": "gateway", "type": "string" }, { - "description": "the network domain for the system VM", - "name": "networkdomain", + "description": "the link local netmask for the system vm", + "name": "linklocalnetmask", "type": "string" }, + {}, { - "description": "the template ID for the system VM", - "name": "templateid", + "description": "the private MAC address for the system VM", + "name": "privatemacaddress", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "guest vlan range", + "name": "guestvlan", "type": "string" }, { - "description": "the system VM type", - "name": "systemvmtype", + "description": "the link local IP address for the system vm", + "name": "linklocalip", "type": "string" }, { - "description": "the public MAC address for the system VM", - "name": "publicmacaddress", + "description": "the second DNS for the system VM", + "name": "dns2", "type": "string" }, - {}, { - "description": "the name of the service offering of the system virtual machine.", - "name": "serviceofferingname", + "description": "the private netmask for the system VM", + "name": "privatenetmask", "type": "string" }, + {}, { "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 hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the private IP address for the system VM", - "name": "privateip", + "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 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 control state of the host for the system VM", - "name": "hostcontrolstate", + "description": "the template ID for the system VM", + "name": "templateid", "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" - }, - { - "description": "the first DNS for the system VM", - "name": "dns1", + "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 agent state of the system VM", + "name": "agentstate", "type": "string" }, { - "description": "the private netmask for the system VM", - "name": "privatenetmask", + "description": "the network domain for the system VM", + "name": "networkdomain", "type": "string" }, { - "description": "the second DNS for the system VM", - "name": "dns2", - "type": "string" + "description": "the date and time the system VM was created", + "name": "created", + "type": "date" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the public IP address for the system VM", + "name": "publicip", + "type": "string" }, { "description": "the link local MAC address for the system vm", "name": "linklocalmacaddress", "type": "string" }, - {} + { + "description": "the hostname for the system VM", + "name": "hostname", + "type": "string" + }, + { + "description": "the number of active console sessions for the console proxy system vm", + "name": "activeviewersessions", + "type": "integer" + } ] }, { @@ -145764,57 +146150,49 @@ "name": "registerVnfTemplate", "params": [ { - "description": "the CPU arch of the template. Valid options are: x86_64, aarch64", + "description": "the tag for this template.", "length": 255, - "name": "arch", + "name": "templatetag", "required": false, - "since": "4.20", "type": "string" }, { - "description": "A list of zone ids where the template will be hosted. Use this parameter if the template needs to be registered to multiple zones in one go. Use zoneid if the template needs to be registered to only one zone.Passing only -1 to this will cause the template to be registered as a cross zone template and will be copied to all zones. ", + "description": "the ID of the zone the template is to be hosted on", "length": 255, - "name": "zoneids", + "name": "zoneid", "related": "listZones", "required": false, - "type": "list" + "type": "uuid" }, { - "description": "ID of the extension", + "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": "extensionid", - "related": "listExtensions", + "name": "zoneids", + "related": "listZones", "required": false, - "since": "4.21.0", - "type": "uuid" + "type": "list" }, { - "description": "an optional accountName. Must be used with domainId.", + "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": "account", + "name": "vnfnics", "required": false, - "type": "string" + "type": "map" }, { - "description": "true if this template is a featured template, false otherwise", + "description": "true if this template requires HVM", "length": 255, - "name": "isfeatured", + "name": "requireshvm", "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.", + "description": "if true, the templates would be available for deploying CKS clusters", "length": 255, - "name": "format", - "required": true, - "type": "string" + "name": "forcks", + "required": false, + "since": "4.21.0", + "type": "boolean" }, { "description": "the checksum value of this template. The parameter containing the checksum will be considered a MD5sum if it is not prefixed\n and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to\n use another algorithm the hexadecimal string is to be prefixed with a string of the form,\n \"{}\", not including the double quotes. In this is the exact string\n representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not\n contain an algorithm called SHA256 or one called sha-256, only SHA-256.", @@ -145824,19 +146202,10 @@ "type": "string" }, { - "description": "the ID of the zone the template is to be hosted on", - "length": 255, - "name": "zoneid", - "related": "listZones", - "required": false, - "type": "uuid" - }, - { - "description": "if true, the templates would be available for deploying CKS clusters", + "description": "true if the template is available to all accounts; default is true", "length": 255, - "name": "forcks", + "name": "ispublic", "required": false, - "since": "4.21.0", "type": "boolean" }, { @@ -145847,19 +146216,19 @@ "type": "integer" }, { - "description": "true if the template type is routing i.e., if template is used to deploy router", + "description": "the target hypervisor for the template", "length": 255, - "name": "isrouting", - "required": false, - "type": "boolean" + "name": "hypervisor", + "required": true, + "type": "string" }, { - "description": "(VMware only) true if VM deployments should preserve all the configurations defined for this template", + "description": "the CPU arch of the template. Valid options are: x86_64, aarch64", "length": 255, - "name": "deployasis", + "name": "arch", "required": false, - "since": "4.15.1", - "type": "boolean" + "since": "4.20", + "type": "string" }, { "description": "true if the template supports the password reset feature; default is false", @@ -145869,40 +146238,47 @@ "type": "boolean" }, { - "description": "true if the template is available to all accounts; default is true", + "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": "ispublic", - "required": false, - "type": "boolean" + "name": "format", + "required": true, + "type": "string" }, { - "description": "true if the template supports the sshkey upload feature; default is false", + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", "length": 255, - "name": "sshkeyenabled", + "name": "isdynamicallyscalable", "required": false, "type": "boolean" }, { - "description": "Details in key/value pairs using format externaldetails[i].keyname=keyvalue. Example: externaldetails[0].endpoint.url=urlvalue", - "length": 255, - "name": "externaldetails", + "description": "The display text of the template, defaults to 'name'.", + "length": 4096, + "name": "displaytext", "required": false, - "since": "4.21.0", - "type": "map" + "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": "the type of the template. Valid options are: USER/VNF (for all users) and SYSTEM/ROUTING/BUILTIN (for admins only).", "length": 255, - "name": "vnfnics", + "name": "templatetype", "required": false, - "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": "the name of the template", "length": 255, - "name": "isdynamicallyscalable", - "required": false, - "type": "boolean" + "name": "name", + "required": true, + "type": "string" }, { "description": "true if template should bypass Secondary Storage and be downloaded to Primary Storage on deployment", @@ -145912,55 +146288,65 @@ "type": "boolean" }, { - "description": "the tag for this template.", + "description": "Template details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", "length": 255, - "name": "templatetag", + "name": "details", "required": false, - "type": "string" + "type": "map" }, { - "description": "the target hypervisor for the template", + "description": "an optional accountName. Must be used with domainId.", "length": 255, - "name": "hypervisor", - "required": true, + "name": "account", + "required": false, "type": "string" }, { - "description": "The display text of the template, defaults to 'name'.", - "length": 4096, - "name": "displaytext", + "description": "(VMware only) true if VM deployments should preserve all the configurations defined for this template", + "length": 255, + "name": "deployasis", "required": false, - "type": "string" + "since": "4.15.1", + "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": "Register template for the project", "length": 255, - "name": "ostypeid", + "name": "projectid", "related": "", "required": false, "type": "uuid" }, { - "description": "VNF details in key/value pairs using format vnfdetails[i].keyname=keyvalue. Example: vnfdetails[0].vendor=xxx&&vnfdetails[0].version=2.0", + "description": "true if the template type is routing i.e., if template is used to deploy router", "length": 255, - "name": "vnfdetails", + "name": "isrouting", "required": false, - "type": "map" + "type": "boolean" }, { - "description": "true if this template requires HVM", + "description": "ID of the extension", "length": 255, - "name": "requireshvm", + "name": "extensionid", + "related": "listExtensions", + "required": false, + "since": "4.21.0", + "type": "uuid" + }, + { + "description": "true if the template supports the sshkey upload feature; default is false", + "length": 255, + "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": "Details in key/value pairs using format externaldetails[i].keyname=keyvalue. Example: externaldetails[0].endpoint.url=urlvalue", "length": 255, - "name": "templatetype", + "name": "externaldetails", "required": false, - "since": "4.19.0", - "type": "string" + "since": "4.21.0", + "type": "map" }, { "description": "true if the template or its derivatives are extractable; default is false", @@ -145969,6 +146355,14 @@ "required": false, "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", + "length": 255, + "name": "ostypeid", + "related": "", + "required": false, + "type": "uuid" + }, { "description": "an optional domainId. If the account parameter is used, domainId must also be used.", "length": 255, @@ -145978,33 +146372,102 @@ "type": "uuid" }, { - "description": "Register template for the project", + "description": "true if this template is a featured template, false otherwise", "length": 255, - "name": "projectid", - "related": "", + "name": "isfeatured", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "Template details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", + "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": "details", + "name": "vnfdetails", "required": false, "type": "map" + } + ], + "related": "registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "response": [ + { + "description": "the template ID", + "name": "id", + "type": "string" }, { - "description": "the name of the template", - "length": 255, + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", + "type": "boolean" + }, + { + "description": "the account id to which the template belongs", + "name": "accountid", + "type": "string" + }, + { + "description": "checksum of the template", + "name": "checksum", + "type": "string" + }, + { + "description": "the tag of this template", + "name": "templatetag", + "type": "string" + }, + { + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", + "type": "boolean" + }, + { + "description": "the ID of the zone for this template", + "name": "zoneid", + "type": "string" + }, + { + "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": "path of the Domain the template belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the template name", "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", + "description": "The ID of extension linked to this template", + "name": "extensionid", + "type": "string" + }, + { + "description": "the date this template 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 status of the template", + "name": "status", + "type": "string" + }, + { + "description": "the id of userdata linked to this template", + "name": "userdataid", "type": "string" }, { @@ -146012,82 +146475,82 @@ "name": "tags", "response": [ { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "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": "tag value", - "name": "value", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "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": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "id of the resource", + "name": "resourceid", "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": "resource type", + "name": "resourcetype", "type": "string" } ], "type": "set" }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", + "description": "the name of the domain to which the template belongs", + "name": "domain", "type": "string" }, { - "description": "the project id of the template", - "name": "projectid", + "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 project name of the template", - "name": "project", + "description": "the project id of the template", + "name": "projectid", "type": "string" }, { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", - "type": "boolean" + "description": "CPU Arch of the template", + "name": "arch", + "type": "string" }, { "description": "VMware only: additional key/value details tied with deploy-as-is template", @@ -146095,20 +146558,14 @@ "type": "map" }, { - "description": "the template name", - "name": "name", - "type": "string" - }, - { - "description": "the name of userdata linked to this template", - "name": "userdataname", - "type": "string" + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", + "type": "boolean" }, - {}, { - "description": "the template ID", - "name": "id", - "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.", @@ -146116,79 +146573,59 @@ "type": "boolean" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", "type": "string" }, { - "description": "the processor bit size", - "name": "bits", - "type": "int" - }, - { - "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", - "name": "userdataparams", + "description": "the ID of the secondary storage host for the template", + "name": "hostid", "type": "string" }, { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, - { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", - "type": "boolean" + "description": "the project name of the template", + "name": "project", + "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 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 name of extension linked to this template", - "name": "extensionname", + "description": "the name of the secondary storage host for the template", + "name": "hostname", "type": "string" }, { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", - "type": "set" - }, - { - "description": "the URL which the template/iso is registered from", - "name": "url", - "type": "string" - }, - { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", - "type": "boolean" + "description": "the processor bit size", + "name": "bits", + "type": "int" }, { - "description": "the id of userdata linked to this template", - "name": "userdataid", + "description": "the name of the zone for this template", + "name": "zonename", "type": "string" }, { - "description": "the template display text", - "name": "displaytext", + "description": "the URL which the template/iso is registered from", + "name": "url", "type": "string" }, { - "description": "path of the Domain the template belongs to", - "name": "domainpath", - "type": "string" + "description": "the size of the template", + "name": "size", + "type": "long" }, { "description": "additional key/value details tied with template", @@ -146196,65 +146633,50 @@ "type": "map" }, { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", - "type": "string" - }, - { - "description": "the date this template was removed", - "name": "removed", - "type": "date" + "description": "If true it indicates that the template can be used for CKS cluster deployments", + "name": "forcks", + "type": "boolean" }, { - "description": "the account name to which the template belongs", - "name": "account", - "type": "string" + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" }, {}, { - "description": "the physical size of the template", - "name": "physicalsize", - "type": "long" + "description": "the ID of the OS type for this template.", + "name": "ostypeid", + "type": "string" }, { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "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" }, { - "description": "the account id to which the template belongs", - "name": "accountid", + "description": "The name of extension linked to this template", + "name": "extensionname", "type": "string" }, { - "description": "the size of the template", - "name": "size", + "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 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": "true if the template is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" - }, - { - "description": "the tag of this template", - "name": "templatetag", - "type": "string" + "description": "the format of the template.", + "name": "format", + "type": "imageformat" }, { "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", @@ -146262,100 +146684,64 @@ "type": "boolean" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the date this template was created", - "name": "created", - "type": "date" - }, - { - "description": "the ID of the zone for this template", - "name": "zoneid", - "type": "string" - }, - { - "description": "checksum of the template", - "name": "checksum", - "type": "string" - }, - { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", + "type": "boolean" }, { "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 template display text", + "name": "displaytext", "type": "string" }, { - "description": "the status of the template", - "name": "status", - "type": "string" + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", + "type": "boolean" }, { - "description": "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", + "type": "boolean" }, { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", - "type": "boolean" + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" }, { - "description": "CPU Arch of the template", - "name": "arch", + "description": "the 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 account name to which the template belongs", + "name": "account", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "name": "isdynamicallyscalable", "type": "boolean" }, { - "description": "the name of the OS type for this template.", - "name": "ostypename", + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", "type": "string" }, { - "description": "the name of the zone for this template", - "name": "zonename", - "type": "string" + "description": "the date this template was created", + "name": "created", + "type": "date" }, { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", + "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": "If true it indicates that the template can be used for CKS cluster deployments", - "name": "forcks", - "type": "boolean" } ], "since": "4.19.0" @@ -146366,19 +146752,11 @@ "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": "", @@ -146388,26 +146766,27 @@ "type": "integer" }, { - "description": "List by keyword", + "description": "start date to filter stats.Use format \"yyyy-MM-dd hh:mm:ss\")", "length": 255, - "name": "keyword", + "name": "startdate", "required": false, - "type": "string" + "type": "date" }, { "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,createVMFromBackup,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "required": false, "type": "list" }, { - "description": "start date to filter stats.Use format \"yyyy-MM-dd hh:mm:ss\")", + "description": "the ID of the virtual machine.", "length": 255, - "name": "startdate", + "name": "id", + "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,createVMFromBackup,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "required": false, - "type": "date" + "type": "uuid" }, { "description": "name of the virtual machine (a substring match is made against the parameter value returning the data for all matching VMs).", @@ -146416,6 +146795,13 @@ "required": false, "type": "string" }, + { + "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, @@ -146426,36 +146812,108 @@ ], "related": "listSystemVmsUsageHistory", "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 name of the virtual machine", - "name": "name", - "type": "string" + "description": "the list of VM stats", + "name": "stats", + "response": [ + { + "description": "the total disk iops since the last stats retrieval", + "name": "diskiopstotal", + "type": "long" + }, + { + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "the target memory in VM (KB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "description": "the amount (percentage) of the VM's CPU currently used", + "name": "cpuused", + "type": "string" + }, + { + "description": "the VM's free memory in KB or -1 if it cannot be gathered", + "name": "memoryintfreekbs", + "type": "long" + }, + { + "description": "the memory used by the VM in KB", + "name": "memorykbs", + "type": "long" + }, + { + "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 number of write requests (IO) made in the last collection cycle as defined by vm.stats.interval configuration", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "the amount of downloaded data by the VM in MiB", + "name": "networkread", + "type": "string" + }, + { + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "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 VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "the amount of uploaded data by the VM in MiB", + "name": "networkwrite", + "type": "string" + } + ], + "type": "list" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the ID of the virtual machine", + "name": "id", + "type": "string" }, { "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", "name": "displayname", "type": "string" }, + {}, { - "description": "the list of VM stats", - "name": "stats", - "type": "list" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "the name of the virtual machine", + "name": "name", "type": "string" } ], @@ -146478,137 +146936,96 @@ "related": "reconnectHost", "response": [ { - "description": "the host version", - "name": "version", - "type": "string" - }, - { - "description": "true if the host supports instance conversion (using virt-v2v)", - "name": "instanceconversionsupported", - "type": "boolean" - }, - { - "description": "the name of the host", - "name": "name", - "type": "string" - }, - { - "description": "true if the host is disconnected. False otherwise.", - "name": "disconnected", - "type": "date" - }, - { - "description": "the OS category ID of the host", - "name": "oscategoryid", + "description": "the cluster type of the cluster that host belongs to", + "name": "clustertype", "type": "string" }, - { - "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", - "type": "long" - }, { "description": "the host HA information information", "name": "hostha", "type": "hostharesponse" }, { - "description": "the resource state of the host", - "name": "resourcestate", - "type": "string" - }, - { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", + "description": "the IP address of the host", + "name": "ipaddress", "type": "string" }, { - "description": "The name of extension for this cluster", - "name": "extensionname", - "type": "string" + "description": "the number of CPU sockets on the host", + "name": "cpusockets", + "type": "integer" }, { - "description": "the CPU speed of the host", - "name": "cpuspeed", - "type": "long" + "description": "the host type", + "name": "type", + "type": "type" }, { - "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": "comma-separated list of storage access groups on the cluster", - "name": "clusterstorageaccessgroups", + "description": "The name of extension for this cluster", + "name": "extensionname", "type": "string" }, { - "description": "the admin that annotated this host", - "name": "username", - "type": "string" + "description": "the last time this host was annotated", + "name": "lastannotated", + "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 management server ID of the host", + "name": "managementserverid", + "type": "string" }, { - "description": "true if the host has capability to support UEFI boot", - "name": "ueficapability", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the date and time the host was created", - "name": "created", - "type": "date" - }, - { - "description": "the IP address of the host", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", - "type": "string" + "description": "Total GPUs on the Host", + "name": "gputotal", + "type": "long" }, { - "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": "the host hypervisor", + "name": "hypervisor", "type": "string" }, - {}, { - "description": "the Pod ID of the host", - "name": "podid", - "type": "string" + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "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 no. of vgpu per gpu card (pgpu)", - "name": "maxvgpuperpgpu", - "type": "long" - }, { "description": "Maximum Y resolution per display", "name": "maxresolutiony", "type": "long" }, { - "description": "Maximum displays per user", - "name": "maxheads", + "description": "Maximum no. of vgpu per gpu card (pgpu)", + "name": "maxvgpuperpgpu", "type": "long" }, { @@ -146622,8 +147039,8 @@ "type": "string" }, { - "description": "Maximum X resolution per display", - "name": "maxresolutionx", + "description": "Maximum displays per user", + "name": "maxheads", "type": "long" }, { @@ -146631,6 +147048,11 @@ "name": "remainingcapacity", "type": "long" }, + { + "description": "Maximum X resolution per display", + "name": "maxresolutionx", + "type": "long" + }, { "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", "name": "maxcapacity", @@ -146638,29 +147060,39 @@ } ], "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", + "description": "comma-separated list of storage access groups on the cluster", + "name": "clusterstorageaccessgroups", "type": "string" }, { - "description": "comma-separated list of implicit host tags for the host", - "name": "implicithosttags", + "description": "the Zone name of the host", + "name": "zonename", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", + "type": "string" + }, + { + "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", + "type": "string" + }, + { + "description": "the resource state of the host", + "name": "resourcestate", + "type": "string" }, { "description": "CPU Arch of the host", @@ -146668,124 +147100,179 @@ "type": "string" }, { - "description": "capabilities of the host", - "name": "capabilities", + "description": "the admin that annotated this host", + "name": "username", "type": "string" }, { - "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", - "name": "hahost", - "type": "boolean" + "description": "the ID of the host", + "name": "id", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the Pod name of the host", + "name": "podname", + "type": "string" }, { - "description": "Total GPUs on the Host", - "name": "gputotal", + "description": "the amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", "type": "long" }, + { + "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", + "type": "string" + }, + { + "description": "the CPU number of the host", + "name": "cpunumber", + "type": "integer" + }, + { + "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 Zone ID of the host", + "name": "zoneid", + "type": "string" + }, { "description": "the state of the host", "name": "state", "type": "status" }, { - "description": "comma-separated list of explicit host tags for the host", - "name": "explicithosttags", + "description": "comma-separated list of storage access groups for the host", + "name": "storageaccessgroups", "type": "string" }, { - "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", - "type": "string" + "description": "the CPU speed of the host", + "name": "cpuspeed", + "type": "long" }, { - "description": "the host hypervisor", - "name": "hypervisor", + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" + }, + { + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" + }, + { + "description": "the amount of the host's memory currently allocated in bytes", + "name": "memoryallocatedbytes", + "type": "long" + }, + { + "description": "the total disk size of the host", + "name": "disksizetotal", + "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", + "description": "the incoming network traffic on the host", + "name": "networkkbsread", "type": "long" }, {}, { - "description": "the number of CPU sockets on the host", - "name": "cpusockets", - "type": "integer" + "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": "comma-separated list of storage access groups on the pod", + "name": "podstorageaccessgroups", + "type": "string" + }, + { + "description": "true if the host is disconnected. False otherwise.", + "name": "disconnected", + "type": "date" }, { - "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 virtual machine id for host type ConsoleProxy and SecondaryStorageVM", - "name": "virtualmachineid", + "description": "comma-separated list of implicit host tags for the host", + "name": "implicithosttags", "type": "string" }, { - "description": "comma-separated list of storage access groups for the host", - "name": "storageaccessgroups", + "description": "the hypervisor version", + "name": "hypervisorversion", "type": "string" }, { - "description": "the amount of the host's memory currently used", - "name": "memoryused", - "type": "long" + "description": "comma-separated list of storage access groups on the zone", + "name": "zonestorageaccessgroups", + "type": "string" }, { - "description": "the host type", - "name": "type", - "type": "type" + "description": "the cpu average load on the host", + "name": "cpuloadaverage", + "type": "double" }, { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", - "type": "string" + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", + "type": "long" }, { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", + "description": "the management server name of the host", + "name": "managementservername", "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 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", + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", + "type": "long" + }, + { + "description": "events available for the host", + "name": "events", "type": "string" }, { - "description": "the date and time the host was last pinged", - "name": "lastpinged", - "type": "date" + "description": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", + "type": "string" }, { - "description": "comma-separated list of storage access groups on the zone", - "name": "zonestorageaccessgroups", + "description": "the last annotation set on this host by an admin", + "name": "annotation", "type": "string" }, { @@ -146794,126 +147281,97 @@ "type": "string" }, { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", - "type": "boolean" + "description": "the name of the host", + "name": "name", + "type": "string" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", + "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", + "description": "capabilities of the host", + "name": "capabilities", "type": "string" }, { - "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 storage access groups on the pod", - "name": "podstorageaccessgroups", + "description": "the OS category ID of the host", + "name": "oscategoryid", "type": "string" }, { - "description": "The ID of extension for this cluster", - "name": "extensionid", - "type": "string" + "description": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", + "type": "boolean" }, { - "description": "the OS category name of the host", - "name": "oscategoryname", - "type": "string" + "description": "the host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" }, { - "description": "the ID of the host", - "name": "id", + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", "type": "string" }, - { - "description": "the last time this host was annotated", - "name": "lastannotated", - "type": "date" - }, { "description": "the cluster name of the host", "name": "clustername", "type": "string" }, + {}, { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", - "type": "long" + "description": "the OS category name of the host", + "name": "oscategoryname", + "type": "string" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "Host details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the Zone ID of the host", - "name": "zoneid", + "description": "the amount of the host's CPU currently used", + "name": "cpuused", "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": "true if the host has capability to support UEFI boot", + "name": "ueficapability", + "type": "boolean" }, { - "description": "the hypervisor version", - "name": "hypervisorversion", - "type": "string" + "description": "the date and time the host was created", + "name": "created", + "type": "date" }, + {}, { - "description": "the Pod name of the host", - "name": "podname", + "description": "the host version", + "name": "version", "type": "string" }, { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", + "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", "type": "string" }, { - "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", - "name": "suitableformigration", - "type": "boolean" - }, - { - "description": "the Zone name of the host", - "name": "zonename", + "description": "comma-separated list of tags for the host", + "name": "hosttags", "type": "string" }, { - "description": "the CPU number of the host", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "the amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", + "description": "Used GPUs on the Host", + "name": "gpuused", "type": "long" }, - { - "description": "events available for the host", - "name": "events", - "type": "string" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -146928,102 +147386,102 @@ "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": "number of Kubernetes cluster master nodes, default is 1. This option is deprecated, please use 'controlnodes' parameter.", "length": 255, - "name": "noderootdisksize", + "name": "masternodes", "required": false, "type": "long" }, { - "description": "number of Kubernetes cluster master nodes, default is 1. This option is deprecated, please use 'controlnodes' parameter.", + "description": "Kubernetes version with which cluster to be launched", "length": 255, - "name": "masternodes", + "name": "kubernetesversionid", + "related": "getUploadParamsForKubernetesSupportedVersion,listKubernetesSupportedVersions", "required": false, - "type": "long" + "type": "uuid" }, { - "description": "user name for the docker image private registry", + "description": "an optional account for the virtual machine. Must be used with domainId.", "length": 255, - "name": "dockerregistryusername", + "name": "account", "required": false, "type": "string" }, { - "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", + "description": "root disk size in GB for each node", "length": 255, - "name": "etcdnodes", + "name": "noderootdisksize", "required": false, - "since": "4.21.0", "type": "long" }, { - "description": "availability zone in which Kubernetes cluster to be launched", + "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": "zoneid", - "related": "listZones", - "required": true, - "type": "uuid" + "name": "cniconfigdetails", + "required": false, + "since": "4.21.0", + "type": "map" }, { - "description": "the ID of the Userdata", + "description": "the AS Number of the network", "length": 255, - "name": "cniconfigurationid", - "related": "", + "name": "asnumber", "required": false, - "since": "4.21.0", - "type": "uuid" + "type": "long" }, { - "description": "(Optional) Node Type to Template ID mapping. If provided, it overrides the default template: System VM template", + "description": "number of Kubernetes cluster worker nodes", "length": 255, - "name": "nodetemplates", + "name": "size", "required": false, - "since": "4.21.0", - "type": "map" + "type": "long" }, { - "description": "Kubernetes version with which cluster to be launched", + "description": "password for the docker image private registry", "length": 255, - "name": "kubernetesversionid", - "related": "listKubernetesSupportedVersions", + "name": "dockerregistrypassword", "required": false, - "type": "uuid" + "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", + "description": "(Optional) Number of Kubernetes cluster etcd nodes, default is 0.In case the number is greater than 0, etcd nodes are separate from master nodes and are provisioned accordingly", "length": 255, - "name": "cniconfigdetails", + "name": "etcdnodes", "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": "the ID of the service offering for the virtual machines in the cluster.", "length": 255, - "name": "externalloadbalanceripaddress", + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "an optional account for the virtual machine. Must be used with domainId.", + "description": "number of Kubernetes cluster control nodes, default is 1", "length": 255, - "name": "account", + "name": "controlnodes", "required": false, - "type": "string" + "type": "long" }, { - "description": "number of Kubernetes cluster worker nodes", + "description": "if true, setups up CloudStack CSI driver", "length": 255, - "name": "size", + "name": "enablecsi", "required": false, - "type": "long" + "since": "4.22.0", + "type": "boolean" + }, + { + "description": "the ID of the Userdata", + "length": 255, + "name": "cniconfigurationid", + "related": "", + "required": false, + "since": "4.21.0", + "type": "uuid" }, { "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", @@ -147034,11 +147492,12 @@ "type": "uuid" }, { - "description": "the AS Number of the network", + "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": "asnumber", + "name": "hypervisor", "required": false, - "type": "long" + "since": "4.21.0", + "type": "string" }, { "description": "Network in which Kubernetes cluster is to be launched", @@ -147049,106 +147508,108 @@ "type": "uuid" }, { - "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": "external load balancer IP address while using shared network with Kubernetes HA cluster", "length": 255, - "name": "keypair", + "name": "externalloadbalanceripaddress", "required": false, "type": "string" }, { - "description": "description for the Kubernetes cluster", + "description": "availability zone in which Kubernetes cluster to be launched", "length": 255, - "name": "description", - "required": false, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" + }, + { + "description": "name for the Kubernetes cluster", + "length": 255, + "name": "name", + "required": true, "type": "string" }, { - "description": "type of the cluster: CloudManaged, ExternalManaged. The default value is CloudManaged.", + "description": "name of the ssh key pair used to login to the virtual machines", "length": 255, - "name": "clustertype", + "name": "keypair", "required": false, - "since": "4.19.0", "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, - "since": "4.21.0", - "type": "map" + "type": "string" }, { - "description": "Deploy cluster for the project", + "description": "(Optional) Node Type to Template ID mapping. If provided, it overrides the default template: System VM template", "length": 255, - "name": "projectid", - "related": "", + "name": "nodetemplates", "required": false, - "type": "uuid" + "since": "4.21.0", + "type": "map" }, { - "description": "password for the docker image private registry", + "description": "(Optional) Node Type to Service Offering ID mapping. If provided, it overrides the serviceofferingid parameter", "length": 255, - "name": "dockerregistrypassword", + "name": "nodeofferings", "required": false, - "type": "string" + "since": "4.21.0", + "type": "map" }, { - "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": "Deploy cluster for the project", "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", + "name": "projectid", + "related": "", "required": false, "type": "uuid" }, { - "description": "URL for the docker image private registry", + "description": "type of the cluster: CloudManaged, ExternalManaged. The default value is CloudManaged.", "length": 255, - "name": "dockerregistryurl", + "name": "clustertype", "required": false, + "since": "4.19.0", "type": "string" } ], "related": "startKubernetesCluster", "response": [ { - "description": "ID of CNI Configuration associated with the cluster", - "name": "cniconfigurationid", - "type": "string" - }, - { - "description": "the name of the service offering of the control nodes on the Kubernetes cluster", - "name": "controlofferingname", + "description": "the ID of the template of the Kubernetes cluster", + "name": "templateid", "type": "string" }, { - "description": "path of the domain to which the Kubernetes cluster belongs", - "name": "domainpath", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "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": "Name of CNI Configuration associated with the cluster", - "name": "cniconfigname", + "description": "the name of the Kubernetes cluster", + "name": "name", "type": "string" }, { @@ -147157,23 +147618,23 @@ "type": "string" }, { - "description": "the account associated with the Kubernetes cluster", - "name": "account", - "type": "string" + "description": "Minimum size of the cluster", + "name": "minsize", + "type": "long" }, { - "description": "the cpu cores of the Kubernetes cluster", - "name": "cpunumber", - "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", + "description": "the description of the Kubernetes cluster", + "name": "description", "type": "string" }, { - "description": "the name of the service offering of the etcd nodes on the Kubernetes cluster", - "name": "etcdofferingname", + "description": "Public IP Address ID of the cluster", + "name": "ipaddressid", "type": "string" }, { @@ -147182,124 +147643,125 @@ "type": "long" }, { - "description": "URL end point for the Kubernetes cluster", - "name": "endpoint", + "description": "the ID of the domain in which the Kubernetes cluster exists", + "name": "domainid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, + {}, { - "description": "the type of the cluster", - "name": "clustertype", - "type": "clustertype" + "description": "the memory the Kubernetes cluster", + "name": "memory", + "type": "string" }, { - "description": "Public IP Address ID of the cluster", - "name": "ipaddressid", + "description": "the account associated with the Kubernetes cluster", + "name": "account", "type": "string" }, { - "description": "the ID of the network of the Kubernetes cluster", - "name": "networkid", - "type": "string" + "description": "the control nodes count for the Kubernetes cluster", + "name": "controlnodes", + "type": "long" }, { - "description": "the name of the domain in which the Kubernetes cluster exists", - "name": "domain", + "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": "Name of CNI Configuration associated with the cluster", + "name": "cniconfigname", + "type": "string" }, { - "description": "the memory the Kubernetes cluster", - "name": "memory", + "description": "the name of the network of the Kubernetes cluster", + "name": "associatednetworkname", "type": "string" }, - {}, { - "description": "the list of virtualmachine associated with this Kubernetes cluster", - "name": "virtualmachines", - "type": "list" + "description": "the state of the Kubernetes cluster", + "name": "state", + "type": "string" }, { - "description": "Maximum size of the cluster", - "name": "maxsize", - "type": "long" + "description": "Whether autoscaling is enabled for the cluster", + "name": "autoscalingenabled", + "type": "boolean" }, { - "description": "the size (worker nodes count) of the Kubernetes cluster", - "name": "size", - "type": "long" + "description": "keypair details", + "name": "keypair", + "type": "string" }, { - "description": "the project id of the Kubernetes cluster", - "name": "projectid", + "description": "URL end point for the Kubernetes cluster", + "name": "endpoint", "type": "string" }, { - "description": "the ID of the service offering of the etcd nodes on the Kubernetes cluster", - "name": "etcdofferingid", + "description": "path of the domain to which the Kubernetes cluster belongs", + "name": "domainpath", "type": "string" }, { - "description": "the name of the Kubernetes cluster", - "name": "name", + "description": "URL end point for the Kubernetes cluster dashboard UI", + "name": "consoleendpoint", "type": "string" }, { - "description": "the name of the service offering of the Kubernetes cluster", - "name": "serviceofferingname", - "type": "string" + "description": "Indicates if the CloudStack CSI driver has been setup in the cluster", + "name": "csienabled", + "type": "boolean" }, { - "description": "Public IP Address of the cluster", - "name": "ipaddress", + "description": "the cpu cores of the Kubernetes cluster", + "name": "cpunumber", "type": "string" }, { - "description": "the description of the Kubernetes cluster", - "name": "description", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "Minimum size of the cluster", - "name": "minsize", - "type": "long" + "description": "the list of virtualmachine associated with this Kubernetes cluster", + "name": "virtualmachines", + "type": "list" }, { - "description": "the ID of the service offering of the Kubernetes cluster", - "name": "serviceofferingid", - "type": "string" + "description": "the 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": "the id of the Kubernetes cluster", + "name": "id", + "type": "string" }, { - "description": "the date when this Kubernetes cluster was created", - "name": "created", - "type": "date" + "description": "the ID of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionid", + "type": "string" }, + {}, { - "description": "URL end point for the Kubernetes cluster dashboard UI", - "name": "consoleendpoint", + "description": "the project name of the Kubernetes cluster", + "name": "project", "type": "string" }, { - "description": "the ID of the template of the Kubernetes cluster", - "name": "templateid", + "description": "the ID of the service offering of the etcd nodes on the Kubernetes cluster", + "name": "etcdofferingid", "type": "string" }, { - "description": "the ID of the service offering of the worker nodes on the Kubernetes cluster", - "name": "workerofferingid", + "description": "the name of the service offering of the Kubernetes cluster", + "name": "serviceofferingname", "type": "string" }, { @@ -147308,64 +147770,73 @@ "type": "string" }, { - "description": "the ID of the service offering of the control nodes on the Kubernetes cluster", - "name": "controlofferingid", + "description": "Public IP Addresses of the etcd nodes", + "name": "etcdips", + "type": "map" + }, + { + "description": "the project id of the Kubernetes cluster", + "name": "projectid", "type": "string" }, { - "description": "the project name of the Kubernetes cluster", - "name": "project", + "description": "the name of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionname", "type": "string" }, { - "description": "the ID of the domain in which the Kubernetes cluster exists", - "name": "domainid", + "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 ID of the network of the Kubernetes cluster", + "name": "networkid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", + "name": "masternodes", + "type": "long" }, { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zonename", + "description": "the ID of the service offering of the Kubernetes cluster", + "name": "serviceofferingid", "type": "string" }, { - "description": "the control nodes count for the Kubernetes cluster", - "name": "controlnodes", - "type": "long" + "description": "ID of CNI Configuration associated with the cluster", + "name": "cniconfigurationid", + "type": "string" }, { - "description": "the name of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionname", - "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 zone of the Kubernetes cluster", + "name": "zonename", + "type": "string" }, - {}, { - "description": "keypair details", - "name": "keypair", + "description": "the ID of the service offering of the worker nodes on the Kubernetes cluster", + "name": "workerofferingid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the date when this Kubernetes cluster was created", + "name": "created", + "type": "date" + }, + { + "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", + "description": "the ID of the service offering of the control nodes on the Kubernetes cluster", + "name": "controlofferingid", "type": "string" } ] @@ -147376,41 +147847,41 @@ "name": "listStorageNetworkIpRange", "params": [ { - "description": "List by keyword", + "description": "optional parameter. Pod uuid, if specicied and range uuid is absent, using it to search the range.", "length": 255, - "name": "keyword", + "name": "podid", + "related": "createManagementNetworkIpRange", "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.", + "description": "List by keyword", "length": 255, - "name": "podid", - "related": "createManagementNetworkIpRange", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "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.", @@ -147424,19 +147895,18 @@ "related": "createStorageNetworkIpRange", "response": [ { - "description": "the network uuid of storage network IP range", - "name": "networkid", + "description": "the Pod uuid for the storage network IP range", + "name": "podid", "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", + "description": "the netmask of the storage network IP range", + "name": "netmask", "type": "string" }, { @@ -147444,7 +147914,6 @@ "name": "id", "type": "string" }, - {}, { "description": "the start ip of the storage network IP range", "name": "startip", @@ -147456,32 +147925,90 @@ "type": "integer" }, { - "description": "the netmask of the storage network IP range", - "name": "netmask", + "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the Zone uuid of the storage network IP range", - "name": "zoneid", + "description": "the network uuid of storage network IP range", + "name": "networkid", "type": "string" }, + {}, { "description": "the gateway of the storage network IP range", "name": "gateway", "type": "string" + } + ], + "since": "3.0.0" + }, + { + "description": "Enables HA for a host", + "isasync": true, + "name": "enableHAForHost", + "params": [ + { + "description": "ID of the host", + "length": 255, + "name": "hostid", + "related": "reconnectHost", + "required": true, + "type": "uuid" + } + ], + "related": "disableHAForHost", + "response": [ + { + "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 HA state of the host", + "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", + "type": "string" + }, + { + "description": "operation status", + "name": "status", + "type": "boolean" + }, + {}, + { + "description": "the ID of the host", + "name": "hostid", + "type": "string" } ], - "since": "3.0.0" + "since": "4.11" }, { "description": "Configures a virtual router element.", @@ -147506,18 +148033,52 @@ ], "related": "", "response": [ - {}, + { + "description": "the project name of the address", + "name": "project", + "type": "string" + }, + { + "description": "path of the domain to which the provider belongs", + "name": "domainpath", + "type": "string" + }, + { + "description": "the physical network service provider id of the provider", + "name": "nspid", + "type": "string" + }, + { + "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 domain associated with the provider", + "name": "domain", + "type": "string" + }, + { + "description": "the project id of the ipaddress", + "name": "projectid", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, {}, { "description": "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", @@ -147528,208 +148089,442 @@ "name": "id", "type": "string" }, + {} + ] + }, + { + "description": "Updates the affinity/anti-affinity group associations of a virtual machine. The VM has to be stopped and restarted for the new properties to take effect.", + "isasync": true, + "name": "updateVMAffinityGroup", + "params": [ { - "description": "path of the domain to which the provider belongs", - "name": "domainpath", + "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" + }, + { + "description": "The ID of the virtual machine", + "length": 255, + "name": "id", + "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,createVMFromBackup,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "required": true, + "type": "uuid" + }, + { + "description": "comma separated list of affinity groups names that are going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupids parameter", + "length": 255, + "name": "affinitygroupnames", + "related": "", + "required": false, + "type": "list" + } + ], + "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,createVMFromBackup,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "response": [ + { + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ + { + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" + }, + { + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name of the affinity group", + "name": "project", + "type": "string" + }, + { + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "the name of the affinity group", + "name": "name", + "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 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": "path of the Domain the affinity group belongs to", + "name": "domainpath", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", + "type": "string" + }, + { + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" + }, + { + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "the user's name who deployed the virtual machine", + "name": "username", + "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 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", + "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 total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "type": "string" + }, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, + { + "description": "the password (if exists) of the virtual machine", + "name": "password", + "type": "string" + }, + { + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the account associated with the provider", - "name": "account", + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "the domain associated with the provider", + "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 ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" + }, + { + "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 type of the template for the virtual machine", + "name": "templatetype", + "type": "string" + }, + { + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" + }, + {}, + { + "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 group name of the virtual machine", + "name": "group", + "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": "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": "Instance lease duration in days", + "name": "leaseduration", + "type": "integer" + }, + { + "description": "the video RAM size in MB", + "name": "videoram", + "type": "long" + }, + { + "description": "Guest vm Boot Type", + "name": "boottype", + "type": "string" + }, + { + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", + "type": "string" + }, + { + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + { + "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 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 physical network service provider id of the provider", - "name": "nspid", - "type": "string" - } - ] - }, - { - "description": "Enables HA for a host", - "isasync": true, - "name": "enableHAForHost", - "params": [ - { - "description": "ID of the host", - "length": 255, - "name": "hostid", - "related": "reconnectHost", - "required": true, - "type": "uuid" - } - ], - "related": "disableHAForHost", - "response": [ + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, {}, { - "description": "the host HA provider", - "name": "haprovider", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "the ID of the host", - "name": "hostid", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, - {}, { - "description": "if host HA is enabled for the host", - "name": "haenable", - "type": "boolean" + "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", + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", "type": "integer" }, { - "description": "the HA state of the host", - "name": "hastate", - "type": "hastate" + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "type": "string" }, { - "description": "operation status", - "name": "status", - "type": "boolean" + "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": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" - } - ], - "since": "4.11" - }, - { - "description": "Updates the affinity/anti-affinity group associations of a virtual machine. The VM has to be stopped and restarted for the new properties to take effect.", - "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 maximum number of display heads", + "name": "maxheads", + "type": "long" }, { - "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": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" }, { - "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": "the VM's primary IP address", + "name": "ipaddress", + "type": "string" + }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "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": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" + }, + { + "description": "the project name of the vm", + "name": "project", + "type": "string" }, { "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", + "description": "the ip address of the nic", + "name": "ipaddress", "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": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "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": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "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 ID of the corresponding network", - "name": "networkid", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { @@ -147738,28 +148533,23 @@ "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": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { @@ -147768,79 +148558,292 @@ "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": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "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": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" }, { "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", "name": "nsxlogicalswitchport", "type": "string" }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, { "description": "Id of the vm to which the nic belongs", "name": "virtualmachineid", "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" } ], "type": "set" }, + { + "description": "the pool type of the virtual machine", + "name": "pooltype", + "type": "string" + }, + { + "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": "User VM type", + "name": "vmtype", + "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": "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": "the UUID of the latest async job acting on this object", + "name": "jobid", + "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": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + { + "description": "the format of the template for the virtual machine", + "name": "templateformat", + "type": "string" + }, + { + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "the 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", + "type": "string" + }, + { + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", + "type": "string" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "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": "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 type of the ICMP message response", - "name": "icmptype", + "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 ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "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": "resource type", + "name": "resourcetype", + "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 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 starting IP of the security group rule", + "name": "startport", "type": "integer" }, { @@ -147852,11 +148855,21 @@ "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ + { + "description": "resource type", + "name": "resourcetype", + "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", @@ -147873,18 +148886,13 @@ "type": "string" }, { - "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": "id of the resource", - "name": "resourceid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -147892,19 +148900,14 @@ "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", + "description": "id of the resource", + "name": "resourceid", "type": "string" } ], @@ -147916,8 +148919,13 @@ "type": "string" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { @@ -147926,13 +148934,8 @@ "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 protocol of the security group rule", + "name": "protocol", "type": "string" }, { @@ -147949,18 +148952,18 @@ "type": "set" }, { - "description": "the name of the security group", - "name": "name", + "description": "the ID of the security group", + "name": "id", "type": "string" }, { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", - "type": "string" + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" }, { - "description": "the ID of the security group", - "name": "id", + "description": "the name of the security group", + "name": "name", "type": "string" }, { @@ -147969,844 +148972,312 @@ "type": "string" }, { - "description": "the domain name of the security group", - "name": "domain", + "description": "the account owning the security group", + "name": "account", "type": "string" }, { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", "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": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" }, { - "description": "resource type", - "name": "resourcetype", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "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 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", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "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" - }, - { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" - }, - { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", - "type": "string" - }, - { - "description": "true if vm has delete protection.", - "name": "deleteprotection", - "type": "boolean" - }, - { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", - "type": "string" - }, - { - "description": "the password (if exists) of the virtual machine", - "name": "password", - "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", - "type": "string" - }, - { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "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": "Os type ID of the virtual machine", - "name": "guestosid", - "type": "string" - }, - { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", - "type": "string" - }, - { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", - "type": "string" - }, - { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" - }, - { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" - }, - { - "description": "the group ID of the virtual machine", - "name": "groupid", - "type": "string" - }, - { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" - }, - {}, - { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", - "type": "string" - }, - { - "description": "the format of the template for the virtual machine", - "name": "templateformat", - "type": "string" - }, - { - "description": "Instance lease duration in days", - "name": "leaseduration", - "type": "integer" - }, - { - "description": "Instance lease expiry action", - "name": "leaseexpiryaction", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the name of the gpu card to which service offering is linked", - "name": "gpucardname", - "type": "string" - }, - { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" - }, - { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", - "type": "string" - }, - { - "description": "Instance lease expiry date", - "name": "leaseexpirydate", - "type": "date" - }, - { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" - }, - { - "description": "the group name of the virtual machine", - "name": "group", - "type": "string" - }, - { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" - }, - { - "description": "the 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 maximum X resolution", - "name": "maxresolutionx", - "type": "long" - }, - { - "description": "the maximum number of display heads", - "name": "maxheads", - "type": "long" - }, - { - "description": "the VM's primary IP address", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the pool type of the virtual machine", - "name": "pooltype", - "type": "string" - }, - { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" - }, - { - "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": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" - }, - { - "description": "the ID of the gpu card to which service offering is linked", - "name": "gpucardid", - "type": "string" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "Guest vm Boot Mode", - "name": "bootmode", - "type": "string" - }, - { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", - "type": "string" - }, - { - "description": "the count of GPUs on the virtual machine", - "name": "gpucount", - "type": "integer" - }, - { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" - }, - { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", - "type": "string" - }, - { - "description": "the name of the vgpu profile to which service offering is linked", - "name": "vgpuprofilename", - "type": "string" - }, - { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", - "type": "string" - }, - { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "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": "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": "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": "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": "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": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + } + ], + "type": "set" } ], "type": "set" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", - "type": "string" - }, - { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" - }, - { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" - }, - { - "description": "the state of the virtual machine", - "name": "state", - "type": "string" - }, - { - "description": "the type of the template for the virtual machine", - "name": "templatetype", - "type": "string" - }, - { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", - "type": "string" - }, - { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" - }, - { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" - }, - { - "description": "the ID of the vgpu profile to which service offering is linked", - "name": "vgpuprofileid", - "type": "string" - }, - { - "description": "User VM type", - "name": "vmtype", - "type": "string" - }, - { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", - "type": "string" - }, - { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" - }, - { - "description": "OS name of the vm", - "name": "osdisplayname", + "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": "device type of the root volume", "name": "rootdevicetype", "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, - { - "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", "type": "string" }, { - "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 date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", "type": "string" }, { - "description": "the 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", + "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "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 template for the virtual machine", - "name": "templatename", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "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 user's name who deployed the virtual machine", - "name": "username", - "type": "string" + "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", + "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", - "type": "boolean" + "description": "the name of the virtual machine", + "name": "name", + "type": "string" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", + "description": "the list of resource tags associated", + "name": "tags", "response": [ { - "description": "the ID of the affinity group", - "name": "id", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the account owning the affinity group", - "name": "account", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "resource type", + "name": "resourcetype", "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 domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" + "description": "tag value", + "name": "value", + "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the project name of the affinity group", + "description": "the project name where tag belongs to", "name": "project", "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], "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": "ssh key-pairs", - "name": "keypairs", - "type": "string" - }, - { - "description": "State of the Service from LB rule", - "name": "servicestate", - "type": "string" - }, - { - "description": "the ID of the virtual machine", - "name": "id", + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", "type": "string" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, - {}, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "CPU arch of the VM", + "name": "arch", "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" - }, - { - "description": "the project id of the vm", - "name": "projectid", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "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": "the name of the virtual machine", - "name": "name", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", + "description": "the maximum X resolution", + "name": "maxresolutionx", "type": "long" }, { - "description": "the 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 ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "CPU arch of the VM", - "name": "arch", + "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 video RAM size in MB", - "name": "videoram", - "type": "long" - }, - { - "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 virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "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", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" } ] @@ -148833,33 +149304,33 @@ ], "related": "listRegisteredServicePackages", "response": [ + { + "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": "Service Package UUID", "name": "id", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "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" - } + {} ] }, { @@ -148868,9 +149339,16 @@ "name": "updateWebhook", "params": [ { - "description": "Description for the Webhook", + "description": "Scope of the Webhook", "length": 255, - "name": "description", + "name": "scope", + "required": false, + "type": "string" + }, + { + "description": "State of the Webhook", + "length": 255, + "name": "state", "required": false, "type": "string" }, @@ -148883,16 +149361,16 @@ "type": "uuid" }, { - "description": "State of the Webhook", + "description": "If set to true then SSL verification will be done for the Webhook otherwise not", "length": 255, - "name": "state", + "name": "sslverification", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "Scope of the Webhook", + "description": "Description for the Webhook", "length": 255, - "name": "scope", + "name": "description", "required": false, "type": "string" }, @@ -148903,13 +149381,6 @@ "required": false, "type": "string" }, - { - "description": "Name for the Webhook", - "length": 255, - "name": "name", - "required": false, - "type": "string" - }, { "description": "Secret key of the Webhook", "length": 255, @@ -148918,17 +149389,18 @@ "type": "string" }, { - "description": "If set to true then SSL verification will be done for the Webhook otherwise not", + "description": "Name for the Webhook", "length": 255, - "name": "sslverification", + "name": "name", "required": false, - "type": "boolean" + "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" }, { @@ -148937,10 +149409,9 @@ "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" }, { @@ -148956,14 +149427,6 @@ "isasync": false, "name": "quotaCredits", "params": [ - { - "description": "Domain for which quota credits need to be added", - "length": 255, - "name": "domainid", - "related": "listDomains", - "required": true, - "type": "uuid" - }, { "description": "Minimum balance threshold of the account", "length": 255, @@ -148971,6 +149434,13 @@ "required": false, "type": "double" }, + { + "description": "Value of the credits to be added+, subtracted-", + "length": 255, + "name": "value", + "required": true, + "type": "double" + }, { "description": "Account for which quota enforce is set to false will not be locked when there is no credit balance", "length": 255, @@ -148979,11 +149449,12 @@ "type": "boolean" }, { - "description": "Value of the credits to be added+, subtracted-", + "description": "Domain for which quota credits need to be added", "length": 255, - "name": "value", + "name": "domainid", + "related": "listDomains", "required": true, - "type": "double" + "type": "uuid" }, { "description": "Account Id for which quota credits need to be added", @@ -148995,6 +149466,17 @@ ], "related": "", "response": [ + { + "description": "Username of the creditor user.", + "name": "creditorusername", + "type": "string" + }, + { + "description": "When the credit was added.", + "name": "creditedon", + "type": "date" + }, + {}, {}, { "description": "The credit deposited.", @@ -149002,14 +149484,13 @@ "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": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Credit's currency.", + "name": "currency", "type": "string" }, { @@ -149017,20 +149498,10 @@ "name": "creditoruserid", "type": "string" }, - { - "description": "When the credit was added.", - "name": "creditedon", - "type": "date" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - { - "description": "Username of the creditor user.", - "name": "creditorusername", - "type": "string" } ], "since": "4.7.0" @@ -149041,75 +149512,61 @@ "name": "discoverGpuDevices", "params": [ { - "description": "", + "description": "ID of the host", "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "name": "id", + "related": "reconnectHost", + "required": true, + "type": "uuid" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "ID of the host", + "description": "", "length": 255, - "name": "id", - "related": "reconnectHost", - "required": true, - "type": "uuid" + "name": "page", + "required": false, + "type": "integer" } ], "related": "listGpuDevices", "response": [ - { - "description": "the vGPU profile name assigned to this GPU device", - "name": "state", - "type": "state" - }, - { - "description": "the vGPU profile ID assigned to this GPU device", - "name": "virtualmachineid", - "type": "string" - }, { "description": "the ID of the GPU device", "name": "id", "type": "string" }, { - "description": "bus address of the GPU device or MDEV UUID for vGPU devices", - "name": "busaddress", + "description": "the NUMA node where the GPU device is located", + "name": "numanode", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the host name where the GPU device is attached", - "name": "hostname", - "type": "string" + "description": "the state of the virtual machine to which this GPU device is allocated", + "name": "vmstate", + "type": "state" }, + {}, { - "description": "the GPU card name associated with this GPU device", - "name": "gpucardname", + "description": "the ID of the parent GPU device, if this is a vGPU", + "name": "parentgpudeviceid", "type": "string" }, { - "description": "the vGPU profile name assigned to this GPU device", - "name": "vgpuprofilename", + "description": "the GPU card ID associated with this GPU device", + "name": "gpucardid", "type": "string" }, { @@ -149117,52 +149574,66 @@ "name": "hostid", "type": "string" }, - {}, - {}, { "description": "the vGPU profile name assigned to this GPU device", - "name": "virtualmachinename", - "type": "string" + "name": "state", + "type": "state" }, { "description": "the vGPU profile ID assigned to this GPU device", - "name": "vgpuprofileid", + "name": "virtualmachineid", "type": "string" }, { - "description": "the NUMA node where the GPU device is located", - "name": "numanode", + "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", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the ID of the parent GPU device, if this is a vGPU", - "name": "parentgpudeviceid", + "description": "bus address of the GPU device or MDEV UUID for vGPU devices", + "name": "busaddress", "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": "vgpuprofileid", "type": "string" }, + {}, { - "description": "the state of the virtual machine to which this GPU device is allocated", - "name": "vmstate", - "type": "state" + "description": "the GPU card name associated with this GPU device", + "name": "gpucardname", + "type": "string" }, { - "description": "bus address of the GPU device", - "name": "gpudevicetype", - "type": "devicetype" + "description": "the vGPU profile name assigned to this GPU device", + "name": "vgpuprofilename", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the 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": "bus address of the GPU device", + "name": "gpudevicetype", + "type": "devicetype" } ], "since": "4.21.0" @@ -149182,33 +149653,33 @@ ], "related": "", "response": [ + {}, { - "description": "The client certificate", - "name": "certificate", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "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" + "description": "The CA certificate(s)", + "name": "cacertificates", + "type": "string" }, { "description": "Private key for the certificate", "name": "privatekey", "type": "string" - } + }, + {} ], "since": "4.11.0" }, @@ -149236,33 +149707,33 @@ ], "related": "", "response": [ - {}, { - "description": "indicates if the certificate has been revoked from the host, failed or skipped", - "name": "status", + "description": "the ID of the host", + "name": "hostid", "type": "string" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the name of the host", - "name": "hostname", + "description": "indicates the details in case of failure or host skipped", + "name": "details", "type": "string" }, + {}, { - "description": "the ID of the host", - "name": "hostid", + "description": "the name of the host", + "name": "hostname", "type": "string" }, { - "description": "indicates the details in case of failure or host skipped", - "name": "details", + "description": "indicates if the certificate has been revoked from the host, failed or skipped", + "name": "status", "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -149277,10 +149748,10 @@ "name": "updateProjectRole", "params": [ { - "description": "ID of the Project role", + "description": "ID of project where role is being created", "length": 255, - "name": "id", - "related": "updateProjectRole", + "name": "projectid", + "related": "", "required": true, "type": "uuid" }, @@ -149291,45 +149762,40 @@ "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", "length": 255, "name": "description", "required": false, "type": "string" + }, + { + "description": "ID of the Project role", + "length": 255, + "name": "id", + "related": "updateProjectRole", + "required": true, + "type": "uuid" } ], "related": "", "response": [ - {}, - { - "description": "the ID of the role", - "name": "id", - "type": "string" - }, { "description": "the description of the role", "name": "description", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "Indicates whether the role will be visible to all users (public) or only to root admins (private). If this parameter is not specified during the creation of the role its value will be defaulted to true (public).", "name": "ispublic", "type": "boolean" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -149340,6 +149806,11 @@ "name": "projectid", "type": "string" }, + { + "description": "the ID of the role", + "name": "id", + "type": "string" + }, { "description": "the name of the role", "name": "name", @@ -149354,13 +149825,6 @@ "isasync": false, "name": "addLdapConfiguration", "params": [ - { - "description": "Hostname", - "length": 255, - "name": "hostname", - "required": true, - "type": "string" - }, { "description": "linked domain", "length": 255, @@ -149369,6 +149833,13 @@ "required": false, "type": "uuid" }, + { + "description": "Hostname", + "length": 255, + "name": "hostname", + "required": true, + "type": "string" + }, { "description": "Port", "length": 255, @@ -149380,16 +149851,112 @@ "related": "", "response": [ { - "description": "port the ldap server is running on", - "name": "port", - "type": "int" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "linked domain", + "name": "domainid", + "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": "port the ldap server is running on", + "name": "port", + "type": "int" + }, + { + "description": "the ID of the LDAP configuration", + "name": "id", + "type": "string" + } + ], + "since": "4.2.0" + }, + { + "description": "List running import virtual machine tasks from a unmanaged hosts into CloudStack", + "isasync": false, + "name": "listImportVmTasks", + "params": [ + { + "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": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "the zone ID", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "Conversion host of the importing task", + "length": 255, + "name": "convertinstancehostid", + "related": "reconnectHost", + "required": false, + "type": "uuid" + }, + { + "description": "Filter tasks by state, valid options are: All, Running, Completed, Failed", + "length": 255, + "name": "tasksfilter", + "required": false, + "type": "string" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "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 vcenter name of the importing VM task", + "name": "vcenter", + "type": "string" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -149400,14 +149967,100 @@ "name": "jobstatus", "type": "integer" }, + { + "description": "the current step description on the importing VM task", + "name": "description", + "type": "string" + }, + { + "description": "the last updated date of the importing task", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the ID of importing task", + "name": "id", + "type": "string" + }, + { + "description": "the state of the importing VM task", + "name": "state", + "type": "string" + }, + { + "description": "the Zone name", + "name": "zonename", + "type": "string" + }, + { + "description": "the total task duration", + "name": "duration", + "type": "string" + }, + { + "description": "the ID of account", + "name": "accountid", + "type": "string" + }, + { + "description": "the duration of the current step", + "name": "stepduration", + "type": "string" + }, + { + "description": "the current step on the importing VM task", + "name": "step", + "type": "string" + }, {}, { - "description": "linked domain", - "name": "domainid", + "description": "the create date of the importing task", + "name": "created", + "type": "date" + }, + { + "description": "the display name of the importing VM", + "name": "displayname", + "type": "string" + }, + { + "description": "the Zone ID", + "name": "zoneid", + "type": "string" + }, + { + "description": "the ID of the imported VM (after task is completed)", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the datacenter name of the importing VM task", + "name": "datacentername", + "type": "string" + }, + { + "description": "the account name", + "name": "account", + "type": "string" + }, + { + "description": "the source VM name", + "name": "sourcevmname", + "type": "string" + }, + { + "description": "the name of the host on which the instance is being converted", + "name": "convertinstancehostname", + "type": "string" + }, + {}, + { + "description": "the ID of the host on which the instance is being converted", + "name": "convertinstancehostid", "type": "string" } ], - "since": "4.2.0" + "since": "4.22" }, { "description": "create Tungsten-Fabric address group", @@ -149421,6 +150074,13 @@ "required": true, "type": "string" }, + { + "description": "Tungsten-Fabric ip prefix length", + "length": 255, + "name": "ipprefixlen", + "required": true, + "type": "integer" + }, { "description": "Tungsten-Fabric address group name", "length": 255, @@ -149435,22 +150095,14 @@ "related": "listZones", "required": true, "type": "uuid" - }, - { - "description": "Tungsten-Fabric ip prefix length", - "length": 255, - "name": "ipprefixlen", - "required": true, - "type": "integer" } ], "related": "", "response": [ - {}, { - "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": "the current status of the latest async job acting on this object", @@ -149464,29 +150116,30 @@ "type": "string" }, { - "description": "Tungsten-Fabric address group ip prefix length", - "name": "ipprefixlen", - "type": "int" + "description": "Tungsten-Fabric address group uuid", + "name": "uuid", + "type": "string" }, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "Tungsten-Fabric address group ip prefix", + "name": "ipprefix", "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": "Tungsten-Fabric address group uuid", - "name": "uuid", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, { - "description": "Tungsten-Fabric address group ip prefix", - "name": "ipprefix", - "type": "string" + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" } ] }, @@ -149496,11 +150149,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", @@ -149510,13 +150163,6 @@ "required": false, "type": "uuid" }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, { "description": "", "length": 255, @@ -149531,6 +150177,13 @@ "related": "", "required": false, "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" } ], "related": "", @@ -149542,24 +150195,33 @@ "type": "string" }, { - "description": "NAT support", - "name": "nat", - "type": "boolean" + "description": "the controller password", + "name": "password", + "type": "string" + }, + { + "description": "device name", + "name": "bigswitchdevicename", + "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": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, { - "description": "name of the provider", - "name": "provider", + "description": "the physical network to which this BigSwitch BCF segment belongs to", + "name": "physicalnetworkid", "type": "string" }, { @@ -149572,20 +150234,11 @@ "name": "username", "type": "string" }, + {}, { - "description": "the physical network to which this BigSwitch BCF segment belongs to", - "name": "physicalnetworkid", - "type": "string" - }, - { - "description": "the controller password", - "name": "password", - "type": "string" - }, - { - "description": "device name", - "name": "bigswitchdevicename", - "type": "string" + "description": "NAT support", + "name": "nat", + "type": "boolean" } ], "since": "4.6.0" @@ -149619,33 +150272,33 @@ ], "related": "", "response": [ - {}, { - "description": "Service Package Name", - "name": "name", + "description": "Service Package UUID", + "name": "id", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "Service Package UUID", - "name": "id", + "description": "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" + }, + {} ] }, { @@ -149661,9 +150314,9 @@ "type": "long" }, { - "description": "the size of the shared filesystem in GiB", + "description": "max iops", "length": 255, - "name": "size", + "name": "maxiops", "required": false, "type": "long" }, @@ -149684,9 +150337,9 @@ "type": "uuid" }, { - "description": "max iops", + "description": "the size of the shared filesystem in GiB", "length": 255, - "name": "maxiops", + "name": "size", "required": false, "type": "long" } @@ -149694,37 +150347,112 @@ "related": "", "response": [ { - "description": "the account associated with the shared filesystem", - "name": "account", + "description": "disk offering for the shared filesystem", + "name": "diskofferingname", + "type": "string" + }, + { + "description": "the shared filesystem's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "Network ID of the shared filesystem", + "name": "networkid", + "type": "string" + }, + { + "description": "the project name of the shared filesystem", + "name": "project", + "type": "string" + }, + { + "description": "size of the shared filesystem in GiB", + "name": "sizegb", + "type": "string" + }, + { + "description": "service offering ID for the shared filesystem", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "ID of the storage fs vm", + "name": "vmstate", + "type": "string" + }, + { + "description": "the write (IO) of disk on the shared filesystem", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "ID of the storage fs vm", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "name of the shared filesystem", + "name": "name", + "type": "string" + }, + { + "description": "size of the shared filesystem", + "name": "size", + "type": "long" + }, + { + "description": "ID of the storage fs data volume", + "name": "volumeid", + "type": "string" + }, + { + "description": "path to mount the shared filesystem", + "name": "path", + "type": "string" + }, + { + "description": "the ID of the domain associated with the shared filesystem", + "name": "domainid", "type": "string" }, + { + "description": "the bytes allocated", + "name": "virtualsize", + "type": "long" + }, { "description": "ID of the storage pool hosting the data volume", "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": "the project name where tag belongs to", - "name": "project", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -149738,33 +150466,113 @@ "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 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 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" } ], "type": "set" }, + { + "description": "the state of the shared filesystem", + "name": "state", + "type": "string" + }, + { + "description": "the project ID of the shared filesystem", + "name": "projectid", + "type": "string" + }, + { + "description": "name of the storage fs data volume", + "name": "volumename", + "type": "string" + }, + { + "description": "the filesystem format", + "name": "filesystem", + "type": "string" + }, + { + "description": "description of the shared filesystem", + "name": "description", + "type": "string" + }, + { + "description": "provisioning type used in the shared filesystem", + "name": "provisioningtype", + "type": "string" + }, + { + "description": "the shared filesystem provider", + "name": "provider", + "type": "string" + }, + { + "description": "disk offering ID for the shared filesystem", + "name": "diskofferingid", + "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 read (IO) of disk on the shared filesystem", + "name": "diskioread", + "type": "long" + }, + { + "description": "the disk utilization", + "name": "utilization", + "type": "string" + }, + { + "description": "the shared filesystem's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "ID of the shared filesystem", + "name": "id", + "type": "string" + }, + { + "description": "Network name of the shared filesystem", + "name": "networkname", + "type": "string" + }, + { + "description": "Name of the availability zone", + "name": "zonename", + "type": "string" + }, { "description": "the list of nics associated with the shared filesystem", "name": "nic", @@ -149775,43 +150583,33 @@ "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": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { @@ -149820,8 +150618,8 @@ "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" }, { @@ -149830,38 +150628,33 @@ "type": "list" }, { - "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": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the ID of the corresponding network", + "name": "networkid", "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": "the traffic type of the nic", - "name": "traffictype", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { @@ -149870,9 +150663,9 @@ "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" }, { "description": "the ID of the nic", @@ -149880,238 +150673,96 @@ "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "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 type of the nic", - "name": "type", + "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": "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": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "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 type of the nic", + "name": "type", "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" } ], "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" - }, - { - "description": "size of the shared filesystem in GiB", - "name": "sizegb", - "type": "string" - }, - { - "description": "the disk utilization", - "name": "utilization", - "type": "string" - }, - { - "description": "ID of the shared filesystem", - "name": "id", - "type": "string" - }, - { - "description": "ID of the storage fs data volume", - "name": "volumeid", - "type": "string" - }, - { - "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": "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", - "type": "string" - }, - { - "description": "Network ID of the shared filesystem", - "name": "networkid", - "type": "string" - }, - { - "description": "size of the shared filesystem", - "name": "size", - "type": "long" - }, - { - "description": "name of the storage fs data volume", - "name": "volumename", - "type": "string" - }, - { - "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", - "type": "string" - }, - { - "description": "the bytes actually consumed on disk", - "name": "physicalsize", - "type": "long" - }, - { - "description": "the ID of the domain associated with the shared filesystem", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain associated with the shared filesystem", - "name": "domain", - "type": "string" - }, - { - "description": "name of the shared filesystem", - "name": "name", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "Name of the availability zone", - "name": "zonename", + "description": "path of the domain to which the shared filesystem", + "name": "domainpath", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "name of the storage pool hosting the data volume", "name": "storage", "type": "string" }, - { - "description": "path of the domain to which the shared filesystem", - "name": "domainpath", - "type": "string" - }, - {}, { "description": "disk offering for the shared filesystem has custom size", "name": "iscustomdiskoffering", "type": "boolean" }, { - "description": "the filesystem format", - "name": "filesystem", - "type": "string" - }, - { - "description": "the write (IO) of disk on the shared filesystem", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "ID of the availability zone", - "name": "zoneid", - "type": "string" - }, - { - "description": "the shared filesystem's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "ID of the storage fs vm", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the bytes allocated", - "name": "virtualsize", - "type": "long" - }, - { - "description": "path to mount the shared filesystem", - "name": "path", - "type": "string" - }, - { - "description": "the shared filesystem provider", - "name": "provider", + "description": "the account associated with the shared filesystem", + "name": "account", "type": "string" }, { - "description": "description of the shared filesystem", - "name": "description", + "description": "the domain associated with the shared filesystem", + "name": "domain", "type": "string" }, { @@ -150119,14 +150770,16 @@ "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", + "type": "string" }, { - "description": "disk offering for the shared filesystem", - "name": "diskofferingname", + "description": "disk offering display text for the shared filesystem", + "name": "diskofferingdisplaytext", "type": "string" } ], @@ -150138,10 +150791,10 @@ "name": "enableStaticNat", "params": [ { - "description": "the ID of the virtual machine for enabling static NAT feature", + "description": "the public IP address ID for which static NAT feature is being enabled", "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", + "name": "ipaddressid", + "related": "updateIpAddress,associateIpAddress,listPublicIpAddresses", "required": true, "type": "uuid" }, @@ -150161,37 +150814,37 @@ "type": "uuid" }, { - "description": "the public IP address ID for which static NAT feature is being enabled", + "description": "the ID of the virtual machine for enabling static NAT feature", "length": 255, - "name": "ipaddressid", - "related": "updateIpAddress,associateIpAddress,listPublicIpAddresses", + "name": "virtualmachineid", + "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,createVMFromBackup,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "required": true, "type": "uuid" } ], "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" - } + }, + {}, + {} ] }, { @@ -150211,11 +150864,6 @@ "response": [ {}, {}, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -150230,6 +150878,11 @@ "description": "true if operation is executed successfully", "name": "success", "type": "boolean" + }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" } ] }, @@ -150258,12 +150911,12 @@ "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", @@ -150279,76 +150932,75 @@ "name": "getUploadParamsForTemplate", "params": [ { - "description": "an optional domainId. If the account parameter is used, domainId must also be used.", + "description": "true if the template is available to all accounts; default is true", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "ispublic", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "the ID of the OS Type that best represents the OS of this template. Not required for VMware as the guest OS is obtained from the OVF file.", + "description": "the format for the volume/template/iso. Possible values include QCOW2, OVA, and VHD.", "length": 255, - "name": "ostypeid", - "related": "", - "required": false, - "type": "uuid" + "name": "format", + "required": true, + "type": "string" }, { - "description": "true if the template or its derivatives are extractable; default is false", + "description": "32 or 64 bits support. 64 by default", "length": 255, - "name": "isextractable", + "name": "bits", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "the display text of the template. This is usually used for display purposes.", - "length": 4096, - "name": "displaytext", + "description": "the tag for this template.", + "length": 255, + "name": "templatetag", "required": false, "type": "string" }, { - "description": "true if the template supports the sshkey upload feature; default is false", + "description": "true if the template type is routing i.e., if template is used to deploy router", "length": 255, - "name": "sshkeyenabled", + "name": "isrouting", "required": false, "type": "boolean" }, { - "description": "true if the template is available to all accounts; default is true", + "description": "an optional domainId. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "ispublic", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "Template details in key/value pairs.", + "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" + "since": "4.22.0", + "type": "string" }, { - "description": "true if this template requires HVM", + "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": "requireshvm", + "name": "checksum", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "if true, the templates would be available for deploying CKS clusters", + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", "length": 255, - "name": "forcks", + "name": "isdynamicallyscalable", "required": false, - "since": "4.21.0", "type": "boolean" }, { - "description": "the name of the volume/template/iso", - "length": 255, - "name": "name", - "required": true, + "description": "the display text of the template. This is usually used for display purposes.", + "length": 4096, + "name": "displaytext", + "required": false, "type": "string" }, { @@ -150359,107 +151011,123 @@ "type": "string" }, { - "description": "(VMware only) true if VM deployments should preserve all the configurations defined for this template", + "description": "Upload volume/template/iso for the project", "length": 255, - "name": "deployasis", + "name": "projectid", + "related": "", "required": false, - "since": "4.15.1", - "type": "boolean" + "type": "uuid" }, { - "description": "true if the template type is routing i.e., if template is used to deploy router", + "description": "the CPU arch of the template. Valid options are: x86_64, aarch64", "length": 255, - "name": "isrouting", + "name": "arch", "required": false, - "type": "boolean" + "since": "4.20", + "type": "string" }, { - "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": "the ID of the zone the volume/template/iso is to be hosted on", + "description": "Template details in key/value pairs.", "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, - "type": "uuid" + "name": "details", + "required": false, + "type": "map" }, { - "description": "true if this template is a featured template, false otherwise", + "description": "true if the template supports the sshkey upload feature; default is false", "length": 255, - "name": "isfeatured", + "name": "sshkeyenabled", "required": false, "type": "boolean" }, { - "description": "32 or 64 bits support. 64 by default", + "description": "the name of the volume/template/iso", "length": 255, - "name": "bits", - "required": false, - "type": "integer" + "name": "name", + "required": true, + "type": "string" }, { - "description": "the tag for this template.", + "description": "the ID of the OS Type that best represents the OS of this template. Not required for VMware as the guest OS is obtained from the OVF file.", "length": 255, - "name": "templatetag", + "name": "ostypeid", + "related": "", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the CPU arch of the template. Valid options are: x86_64, aarch64", + "description": "the ID of the zone the volume/template/iso is to be hosted on", "length": 255, - "name": "arch", + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" + }, + { + "description": "true if the template supports the password reset feature; default is false", + "length": 255, + "name": "passwordenabled", "required": false, - "since": "4.20", - "type": "string" + "type": "boolean" }, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "description": "true if this template requires HVM", "length": 255, - "name": "isdynamicallyscalable", + "name": "requireshvm", "required": false, "type": "boolean" }, { - "description": "the target hypervisor for the template", + "description": "(VMware only) true if VM deployments should preserve all the configurations defined for this template", "length": 255, - "name": "hypervisor", - "required": true, - "type": "string" + "name": "deployasis", + "required": false, + "since": "4.15.1", + "type": "boolean" }, { - "description": "the checksum value of this volume/template/iso The parameter containing the checksum will be considered a MD5sum if it is not prefixed\n and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to\n use another algorithm the hexadecimal string is to be prefixed with a string of the form,\n \"{}\", not including the double quotes. In this is the exact string\n representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not\n contain an algorithm called SHA256 or one called sha-256, only SHA-256.", + "description": "true if the template or its derivatives are extractable; default is false", "length": 255, - "name": "checksum", + "name": "isextractable", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "Upload volume/template/iso for the project", + "description": "if true, the templates would be available for deploying CKS clusters", "length": 255, - "name": "projectid", - "related": "", + "name": "forcks", "required": false, - "type": "uuid" + "since": "4.21.0", + "type": "boolean" }, { - "description": "the format for the volume/template/iso. Possible values include QCOW2, OVA, and VHD.", + "description": "true if this template is a featured template, false otherwise", "length": 255, - "name": "format", - "required": true, - "type": "string" + "name": "isfeatured", + "required": false, + "type": "boolean" } ], "related": "getUploadParamsForIso", "response": [ { - "description": "the template/volume ID", - "name": "id", - "type": "uuid" + "description": "signature to be sent in the POST request.", + "name": "signature", + "type": "string" + }, + {}, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "encrypted data to be sent in the POST request.", @@ -150467,31 +151135,24 @@ "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": "POST url to upload the file to", "name": "postURL", "type": "url" }, { - "description": "the current status of the latest 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 timestamp after which the signature expires", "name": "expires", "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" } ], "since": "4.6.0" @@ -150519,6 +151180,7 @@ } ], "response": [ + {}, { "description": "any text associated with the success or failure", "name": "displaytext", @@ -150529,18 +151191,17 @@ "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" + } ] }, { @@ -150560,56 +151221,56 @@ "related": "", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Netris Provider name", + "name": "name", "type": "string" }, + {}, { "description": "Netris Tag for vNets", "name": "netristag", "type": "string" }, - {}, { - "description": "Zone ID to which the Netris Provider is associated with", - "name": "zoneid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "Netris provider uuid", + "name": "uuid", "type": "string" }, + {}, { "description": "Netris Provider URL", "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": "Zone ID to which the Netris Provider is associated with", + "name": "zoneid", "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": "Zone name to which the Netris Provider is associated with", - "name": "zonename", - "type": "string" } ], "since": "4.21.0" @@ -150619,13 +151280,6 @@ "isasync": false, "name": "listTrafficTypeImplementors", "params": [ - { - "description": "Optional. The network traffic type, if specified, return its implementor. Otherwise, return all traffic types with their implementor", - "length": 255, - "name": "traffictype", - "required": false, - "type": "string" - }, { "description": "List by keyword", "length": 255, @@ -150646,31 +151300,38 @@ "name": "page", "required": false, "type": "integer" + }, + { + "description": "Optional. The network traffic type, if specified, return its implementor. Otherwise, return all traffic types with their implementor", + "length": 255, + "name": "traffictype", + "required": false, + "type": "string" } ], "related": "", "response": [ { - "description": "implementor of network traffic type", - "name": "traffictypeimplementor", + "description": "network traffic type", + "name": "traffictype", "type": "string" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + { + "description": "implementor of network traffic type", + "name": "traffictypeimplementor", + "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" @@ -150682,30 +151343,15 @@ "params": [], "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", "type": "string" }, { - "description": "the version of the currently running DB", - "name": "versioncomment", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the time these statistics were collected", + "name": "collectiontime", + "type": "date" }, { "description": "the uptime of the DB in seconds", @@ -150718,13 +151364,18 @@ "type": "double[]" }, { - "description": "the name of the active usage server", - "name": "hostname", + "description": "the version of the currently running DB", + "name": "version", "type": "string" }, { - "description": "the version of the currently running DB", - "name": "version", + "description": "the current status of the latest 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" }, { @@ -150732,18 +151383,28 @@ "name": "connections", "type": "int" }, - { - "description": "the number of queries performed on the DB", - "name": "queries", - "type": "long" - }, { "description": "the state of the usage server", "name": "replicas", "type": "string[]" }, + { + "description": "the version of the currently running DB", + "name": "versioncomment", + "type": "string" + }, {}, - {} + {}, + { + "description": "the name of the active usage server", + "name": "hostname", + "type": "string" + }, + { + "description": "the number of queries performed on the DB", + "name": "queries", + "type": "long" + } ], "since": "4.17.0" }, @@ -150763,9 +151424,9 @@ ], "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", @@ -150779,9 +151440,9 @@ "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" }, {} ], @@ -150793,64 +151454,50 @@ "name": "listAutoScaleVmProfiles", "params": [ { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, - { - "description": "the ID of the autoscale vm profile", - "length": 255, - "name": "id", - "related": "listAutoScaleVmProfiles", - "required": false, - "type": "uuid" - }, - { - "description": "", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "pagesize", + "name": "fordisplay", "required": false, - "type": "integer" + "since": "4.4", + "type": "boolean" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "account", + "name": "isrecursive", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "the templateid of the autoscale vm profile", + "description": "the ID of the autoscale vm profile", "length": 255, - "name": "templateid", - "related": "registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "name": "id", + "related": "listAutoScaleVmProfiles", "required": false, "type": "uuid" }, { - "description": "availability zone for the auto deployed virtual machine", + "description": "list profiles by service offering id", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", "required": false, "since": "4.4", "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": "If set to false, list only resources belonging to the command's caller; if set to true - list resources 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 only resources belonging to the domain specified", @@ -150861,12 +151508,18 @@ "type": "uuid" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "the otherdeployparameters of the autoscale vm profile", "length": 255, - "name": "fordisplay", + "name": "otherdeployparams", "required": false, - "since": "4.4", - "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": "", @@ -150876,11 +151529,21 @@ "type": "integer" }, { - "description": "the otherdeployparameters of the autoscale vm profile", + "description": "the templateid of the autoscale vm profile", "length": 255, - "name": "otherdeployparams", + "name": "templateid", + "related": "registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", "required": false, - "type": "string" + "type": "uuid" + }, + { + "description": "availability zone for the auto deployed virtual machine", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "since": "4.4", + "type": "uuid" }, { "description": "list objects by project; if projectid=-1 lists All VMs", @@ -150891,126 +151554,124 @@ "type": "uuid" }, { - "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": "", "response": [ { - "description": "the time allowed for existing connections to get closed before a vm is destroyed", - "name": "expungevmgraceperiod", - "type": "integer" + "description": "is profile for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the ID of the user used to launch and destroy the VMs", - "name": "autoscaleuserid", - "type": "string" + "description": "parameters other than zoneId/serviceOfferringId/templateId to be used while deploying a virtual machine", + "name": "otherdeployparams", + "type": "map" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "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 ID of the user used to launch and destroy the VMs", + "name": "autoscaleuserid", "type": "string" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "the project name of the vm profile", + "name": "project", "type": "string" }, { - "description": "the project id vm profile", - "name": "projectid", + "description": "the domain ID of the vm profile", + "name": "domainid", "type": "string" }, - {}, - {}, { - "description": "the account owning the instance group", - "name": "account", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, - {}, { - "description": "the project name of the vm profile", - "name": "project", + "description": "the service offering to be used while deploying a virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the autoscale vm profile ID", - "name": "id", + "description": "the project id vm profile", + "name": "projectid", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, + {}, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "the domain name of the vm profile", + "name": "domain", "type": "string" }, - {}, { - "description": "parameters other than zoneId/serviceOfferringId/templateId to be used while deploying a virtual machine", - "name": "otherdeployparams", - "type": "map" + "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": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "type": "string" }, { - "description": "the service offering to be used while deploying a virtual machine", - "name": "serviceofferingid", + "description": "Base64 encoded VM user data", + "name": "userdata", "type": "string" }, { - "description": "the template to be used while deploying a virtual machine", - "name": "templateid", + "description": "the autoscale vm profile ID", + "name": "id", "type": "string" }, { - "description": "the domain name of the vm profile", - "name": "domain", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "path of the domain to which the vm profile belongs", - "name": "domainpath", + "description": "the template to be used while deploying a virtual machine", + "name": "templateid", "type": "string" }, { - "description": "the availability zone to be used while deploying a virtual machine", - "name": "zoneid", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "the domain ID of the vm profile", - "name": "domainid", - "type": "string" + "description": "the time allowed for existing connections to get closed before a vm is destroyed", + "name": "expungevmgraceperiod", + "type": "integer" }, { - "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" + }, + {} ] }, { @@ -151019,45 +151680,45 @@ "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": "start port for this ingress rule", "length": 255, - "name": "protocol", + "name": "startport", "required": false, - "type": "string" + "type": "integer" }, { - "description": "error code for this icmp message", + "description": "an optional account for the security group. Must be used with domainId.", "length": 255, - "name": "icmpcode", + "name": "account", "required": false, - "type": "integer" + "type": "string" }, { - "description": "The ID of the security group. Mutually exclusive with securityGroupName parameter", + "description": "type of the icmp message being sent", "length": 255, - "name": "securitygroupid", - "related": "", + "name": "icmptype", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "The name of the security group. Mutually exclusive with securityGroupId parameter", + "description": "error code for this icmp message", "length": 255, - "name": "securitygroupname", + "name": "icmpcode", "required": false, - "type": "string" + "type": "integer" }, { - "description": "user to security group mapping", + "description": "The ID of the security group. Mutually exclusive with securityGroupName parameter", "length": 255, - "name": "usersecuritygrouplist", + "name": "securitygroupid", + "related": "", "required": false, - "type": "map" + "type": "uuid" }, { - "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" }, @@ -151069,13 +151730,6 @@ "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,102 +151739,125 @@ "type": "uuid" }, { - "description": "end port for this ingress rule", + "description": "the cidr list associated. Multiple entries must be separated by a single comma character (,).", "length": 255, - "name": "endport", + "name": "cidrlist", "required": false, - "type": "integer" + "type": "list" }, { - "description": "start port for this ingress rule", + "description": "user to security group mapping", "length": 255, - "name": "startport", + "name": "usersecuritygrouplist", "required": false, - "type": "integer" + "type": "map" }, { - "description": "the cidr list associated. Multiple entries must be separated by a single comma character (,).", + "description": "The name of the security group. Mutually exclusive with securityGroupId parameter", "length": 255, - "name": "cidrlist", + "name": "securitygroupname", "required": false, - "type": "list" + "type": "string" + }, + { + "description": "end port for this ingress rule", + "length": 255, + "name": "endport", + "required": false, + "type": "integer" } ], "related": "", "response": [ + {}, { - "description": "the protocol of the security group rule", - "name": "protocol", + "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" }, { - "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 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 current status of the latest 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 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 code for the ICMP message response", - "name": "icmpcode", + "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 UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "the account associated with the tag", - "name": "account", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -151189,8 +151866,8 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -151199,33 +151876,17 @@ "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", + "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" } ], "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" } ] }, @@ -151246,63 +151907,58 @@ "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance", "response": [ { - "description": "total IOPS currently in use", - "name": "usediops", - "type": "long" + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", - "type": "long" + "description": "the storage pool details", + "name": "details", + "type": "map" }, { - "description": "the Zone name of the storage pool", - "name": "zonename", + "description": "the tags for the storage pool", + "name": "tags", "type": "string" }, { - "description": "the host's currently allocated disk size", + "description": "the pool's currently allocated disk size", "name": "disksizeallocated", "type": "long" }, { - "description": "the Pod name of the storage pool", - "name": "podname", + "description": "the Zone name of the storage pool", + "name": "zonename", "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", + "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 tags for the storage pool", - "name": "tags", - "type": "string" - }, - { - "description": "the nfs mount options for the storage pool", - "name": "nfsmountopts", - "type": "string" + "description": "the pool's currently used disk size", + "name": "disksizeused", + "type": "long" }, { - "description": "the Zone ID of the storage pool", - "name": "zoneid", - "type": "string" + "description": "total IOPS currently in use", + "name": "usediops", + "type": "long" }, { - "description": "the ID of the cluster for the storage pool", - "name": "clusterid", + "description": "the Pod name of the storage pool", + "name": "podname", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the IP address of the storage pool", + "name": "ipaddress", "type": "string" }, { @@ -151311,116 +151967,126 @@ "type": "string" }, { - "description": "the scope of the storage pool", - "name": "scope", + "description": "the storage pool type", + "name": "type", "type": "string" }, { - "description": "IOPS CloudStack can provision from this storage pool", - "name": "capacityiops", - "type": "long" - }, - { - "description": "the name of the cluster for the storage pool", - "name": "clustername", + "description": "the hypervisor type of the storage pool", + "name": "hypervisor", "type": "string" }, - {}, { "description": "true if the entity/resource has annotations", "name": "hasannotations", "type": "boolean" }, { - "description": "the hypervisor type of the storage pool", - "name": "hypervisor", - "type": "string" + "description": "the date and time the storage pool was created", + "name": "created", + "type": "date" }, - {}, { - "description": "the IP address of the storage pool", - "name": "ipaddress", + "description": "the name of the storage pool", + "name": "name", "type": "string" }, { - "description": "the storage pool type", - "name": "type", + "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": "Storage provider for this pool", "name": "provider", "type": "string" }, { - "description": "the total disk size of the storage pool", - "name": "disksizetotal", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + { + "description": "the nfs mount options for the storage pool", + "name": "nfsmountopts", + "type": "string" }, { "description": "the Pod ID of the storage pool", "name": "podid", "type": "string" }, + {}, { - "description": "the overprovisionfactor for the storage pool", - "name": "overprovisionfactor", + "description": "the UUID of the latest async 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": "bytes CloudStack can provision from this storage pool", + "name": "capacitybytes", + "type": "long" }, { - "description": "the storage pool capabilities", - "name": "storagecapabilities", - "type": "map" + "description": "IOPS CloudStack can provision from this storage pool", + "name": "capacityiops", + "type": "long" }, { - "description": "the storage pool details", - "name": "details", - "type": "map" + "description": "the storage access groups for the storage pool", + "name": "storageaccessgroups", + "type": "string" }, { - "description": "the storage pool path", - "name": "path", + "description": "the Zone ID of the storage pool", + "name": "zoneid", "type": "string" }, { - "description": "whether this pool is managed or not", - "name": "managed", - "type": "boolean" + "description": "the name of the cluster for the storage pool", + "name": "clustername", + "type": "string" }, { - "description": "the storage access groups for the storage pool", - "name": "storageaccessgroups", - "type": "string" + "description": "the storage pool capabilities", + "name": "storagecapabilities", + "type": "map" }, { - "description": "the name of the storage pool", - "name": "name", + "description": "the ID of the cluster for the storage pool", + "name": "clusterid", "type": "string" }, + { + "description": "whether this pool is managed or not", + "name": "managed", + "type": "boolean" + }, { "description": "the storage pool custom stats", "name": "storagecustomstats", "type": "map" }, - { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", - "type": "boolean" - }, { "description": "the state of the storage pool", "name": "state", "type": "storagepoolstatus" }, { - "description": "true if this pool is suitable to migrate a volume, false otherwise", - "name": "suitableformigration", - "type": "boolean" + "description": "the overprovisionfactor for the storage pool", + "name": "overprovisionfactor", + "type": "string" + }, + { + "description": "total min IOPS currently in use by volumes", + "name": "allocatediops", + "type": "long" } ], "since": "4.15.1" @@ -151431,26 +152097,25 @@ "name": "updateBucket", "params": [ { - "description": "Enable/Disable Bucket encryption", + "description": "Bucket Access Policy", "length": 255, - "name": "encryption", + "name": "policy", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "Bucket Access Policy", + "description": "Enable/Disable Bucket Versioning", "length": 255, - "name": "policy", + "name": "versioning", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "The ID of the Bucket", + "description": "Enable/Disable Bucket encryption", "length": 255, - "name": "id", - "related": "", - "required": true, - "type": "uuid" + "name": "encryption", + "required": false, + "type": "boolean" }, { "description": "Bucket Quota in GiB", @@ -151460,11 +152125,12 @@ "type": "integer" }, { - "description": "Enable/Disable Bucket Versioning", + "description": "The ID of the Bucket", "length": 255, - "name": "versioning", - "required": false, - "type": "boolean" + "name": "id", + "related": "", + "required": true, + "type": "uuid" } ], "response": [ @@ -151473,23 +152139,23 @@ "name": "displaytext", "type": "string" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - {}, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } + {} ], "since": "4.19.0" }, @@ -151499,19 +152165,19 @@ "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. ", + "description": "Update resource limits for project", "length": 255, - "name": "resourcetype", + "name": "projectid", + "related": "", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "If account parameter specified then updates resource counts for a specified account in this domain else update resource counts for all accounts & child domains in specified domain.", + "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": "domainid", - "related": "listDomains", - "required": true, - "type": "uuid" + "name": "resourcetype", + "required": false, + "type": "integer" }, { "description": "Tag for the resource type", @@ -151522,63 +152188,57 @@ "type": "string" }, { - "description": "Update resource count for a specified account. Must be used with the domainId parameter.", + "description": "If account parameter specified then updates resource counts for a specified account in this domain else update resource counts for all accounts & child domains in specified domain.", "length": 255, - "name": "account", - "required": false, - "type": "string" + "name": "domainid", + "related": "listDomains", + "required": true, + "type": "uuid" }, { - "description": "Update resource limits for project", + "description": "Update resource count for a specified account. Must be used with the domainId parameter.", "length": 255, - "name": "projectid", - "related": "", + "name": "account", "required": false, - "type": "uuid" + "type": "string" } ], "related": "", "response": [ { - "description": "the account for which resource count's are updated", - "name": "account", + "description": "path of the domain to which the resource counts are updated", + "name": "domainpath", "type": "string" }, { - "description": "the project name for which resource count's are updated", - "name": "project", + "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": "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 project name for which resource count's are updated", + "name": "project", "type": "string" }, - {}, { "description": "The resource count", "name": "resourcecount", "type": "long" }, - { - "description": "path of the domain to which the resource counts are updated", - "name": "domainpath", - "type": "string" - }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the 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": "Tag for the resource", + "name": "tag", "type": "string" }, { @@ -151587,8 +152247,8 @@ "type": "string" }, { - "description": "Tag for the resource", - "name": "tag", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -151596,6 +152256,12 @@ "name": "resourcetype", "type": "string" }, + { + "description": "the project id for which resource count's are updated", + "name": "projectid", + "type": "string" + }, + {}, { "description": "the domain ID for which resource count's are updated", "name": "domainid", @@ -151609,54 +152275,54 @@ "name": "listRoles", "params": [ { - "description": "List by keyword", + "description": "List role by role name.", "length": 255, - "name": "keyword", + "name": "name", "required": false, "type": "string" }, { - "description": "List role by role type status, valid options are: enabled, disabled", + "description": "", "length": 255, - "name": "state", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "List role by role name.", + "description": "List role by role ID.", "length": 255, - "name": "name", + "name": "id", + "related": "listRoles", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "List role by role type, valid options are: Admin, ResourceAdmin, DomainAdmin, User.", + "description": "", "length": 255, - "name": "type", + "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": "List role by role ID.", + "description": "List role by role type, valid options are: Admin, ResourceAdmin, DomainAdmin, User.", "length": 255, - "name": "id", - "related": "listRoles", + "name": "type", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "", + "description": "List role by role type status, valid options are: enabled, disabled", "length": 255, - "name": "page", + "name": "state", "required": false, - "type": "integer" + "type": "string" } ], "related": "", @@ -151666,6 +152332,12 @@ "name": "ispublic", "type": "boolean" }, + {}, + { + "description": "true if role is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, { "description": "the type of the role", "name": "type", @@ -151677,37 +152349,31 @@ "type": "string" }, { - "description": "the ID of the role", - "name": "id", + "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": "true if role is default, false otherwise", - "name": "isdefault", - "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", + "description": "the ID of the role", + "name": "id", "type": "string" }, - {}, { "description": "the description of the role", "name": "description", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - {} + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } ], "since": "4.9.0" }, @@ -151717,11 +152383,12 @@ "name": "listTungstenFabricPolicy", "params": [ { - "description": "List by keyword", + "description": "the ID of ip address", "length": 255, - "name": "keyword", + "name": "ipaddressid", + "related": "updateIpAddress,associateIpAddress,listPublicIpAddresses", "required": false, - "type": "string" + "type": "uuid" }, { "description": "the ID of network", @@ -151731,14 +152398,6 @@ "required": false, "type": "uuid" }, - { - "description": "the ID of zone", - "length": 255, - "name": "zoneid", - "related": "listZones", - "required": false, - "type": "uuid" - }, { "description": "", "length": 255, @@ -151746,14 +152405,6 @@ "required": false, "type": "integer" }, - { - "description": "the ID of ip address", - "length": 255, - "name": "ipaddressid", - "related": "updateIpAddress,associateIpAddress,listPublicIpAddresses", - "required": false, - "type": "uuid" - }, { "description": "the uuid of Tungsten-Fabric policy", "length": 255, @@ -151767,48 +152418,63 @@ "name": "pagesize", "required": false, "type": "integer" + }, + { + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" } ], "related": "", "response": [ { - "description": "Tungsten-Fabric tag type uuid", - "name": "uuid", + "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": "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 type uuid", + "name": "uuid", "type": "string" }, { - "description": "Tungsten-Fabric policy name", - "name": "name", + "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", + "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } + {} ] }, { @@ -151834,45 +152500,45 @@ ], "related": "extractSnapshot,extractTemplate", "response": [ - {}, { - "description": "zone name the object was extracted from", - "name": "zonename", + "description": "type of the storage", + "name": "storagetype", "type": "string" }, { - "description": "the percentage of the entity uploaded to the specified location", - "name": "uploadpercentage", - "type": "integer" + "description": "the state of the extracted object", + "name": "state", + "type": "string" }, { - "description": "the status of the extraction", - "name": "status", + "description": "the upload id of extracted object", + "name": "extractId", "type": "string" }, { - "description": "the time and date the object was created", - "name": "created", - "type": "date" + "description": "zone ID the object was extracted from", + "name": "zoneid", + "type": "string" }, { - "description": "the id of extracted object", - "name": "id", + "description": "if mode = upload then url of the uploaded entity. if mode = download the url from which the entity can be downloaded", + "name": "url", "type": "string" }, { - "description": "the account id to which the extracted object belongs", - "name": "accountid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "zone ID the object was extracted from", - "name": "zoneid", + "description": "the status of the extraction", + "name": "status", "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 name of the extracted object", + "name": "name", "type": "string" }, { @@ -151881,40 +152547,40 @@ "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 UUID of the latest async job acting on this object", - "name": "jobid", + "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 time and date the object was created", + "name": "created", + "type": "date" }, { "description": "", "name": "resultstring", "type": "string" }, - {}, { - "description": "the state of the extracted object", - "name": "state", + "description": "zone name the object was extracted from", + "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 extracted object", + "name": "id", + "type": "string" }, + {}, { - "description": "the upload id of extracted object", - "name": "extractId", - "type": "string" + "description": "the percentage of the entity uploaded to the specified location", + "name": "uploadpercentage", + "type": "integer" } ], "since": "4.19.0" @@ -151935,31 +152601,31 @@ ], "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 cloud identifier", - "name": "cloudidentifier", - "type": "string" - }, - {}, { "description": "the signed response for the cloud identifier", "name": "signature", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the user ID for the cloud identifier", + "name": "userid", "type": "string" }, + {}, { - "description": "the user ID for the cloud identifier", - "name": "userid", + "description": "the cloud identifier", + "name": "cloudidentifier", "type": "string" } ] @@ -151970,12 +152636,18 @@ "name": "createLBStickinessPolicy", "params": [ { - "description": "an optional field, whether to the display the rule to the end user or not", + "description": "name of the load balancer stickiness policy method, possible values are LbCookie, AppCookie, SourceBased", "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" + "name": "methodname", + "required": true, + "type": "string" + }, + { + "description": "name of the load balancer stickiness policy", + "length": 255, + "name": "name", + "required": true, + "type": "string" }, { "description": "the description of the load balancer stickiness policy", @@ -151992,41 +152664,29 @@ "required": true, "type": "uuid" }, - { - "description": "name of the load balancer stickiness policy method, possible values are LbCookie, AppCookie, SourceBased", - "length": 255, - "name": "methodname", - "required": true, - "type": "string" - }, - { - "description": "name of the load balancer stickiness policy", - "length": 255, - "name": "name", - "required": true, - "type": "string" - }, { "description": "param list. Example: param[0].name=cookiename¶m[0].value=LBCookie ", "length": 255, "name": "param", "required": false, "type": "map" + }, + { + "description": "an optional field, whether to the display the rule to the end user or not", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" } ], "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 domain of the Stickiness policy", + "name": "domain", "type": "string" }, - {}, { "description": "the LB rule ID", "name": "lbruleid", @@ -152037,9 +152697,20 @@ "name": "domainid", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the account of the Stickiness policy", + "name": "account", + "type": "string" + }, + { + "description": "the description of the Stickiness policy", + "name": "description", + "type": "string" + }, + { + "description": "the state of the policy", + "name": "state", "type": "string" }, { @@ -152053,38 +152724,29 @@ "type": "string" }, { - "description": "the account of the Stickiness policy", - "name": "account", - "type": "string" - }, - { - "description": "the domain of the Stickiness policy", - "name": "domain", + "description": "the id of the zone the Stickiness policy belongs to", + "name": "zoneid", "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 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", "type": "string" }, { - "description": "the params of the policy", - "name": "params", - "type": "map" + "description": "the state of the policy", + "name": "state", + "type": "string" }, { "description": "is policy for display to the regular user", @@ -152092,24 +152754,28 @@ "type": "boolean" }, { - "description": "the name of the Stickiness policy", - "name": "name", + "description": "the LB Stickiness policy ID", + "name": "id", "type": "string" }, { - "description": "the state of the policy", - "name": "state", + "description": "the params of the policy", + "name": "params", + "type": "map" + }, + { + "description": "the description of the Stickiness policy", + "name": "description", "type": "string" }, { - "description": "the LB Stickiness policy ID", - "name": "id", + "description": "the name of the Stickiness policy", + "name": "name", "type": "string" } ], "type": "list" - }, - {} + } ], "since": "3.0.0" }, @@ -152118,14 +152784,6 @@ "isasync": false, "name": "addCiscoAsa1000vResource", "params": [ - { - "description": "the Physical Network ID", - "length": 255, - "name": "physicalnetworkid", - "related": "", - "required": true, - "type": "uuid" - }, { "description": "Hostname or ip address of the Cisco ASA 1000v appliance.", "length": 255, @@ -152134,11 +152792,12 @@ "type": "string" }, { - "description": "Nexus port profile associated with inside interface of ASA 1000v", + "description": "the Physical Network ID", "length": 255, - "name": "insideportprofile", + "name": "physicalnetworkid", + "related": "", "required": true, - "type": "string" + "type": "uuid" }, { "description": "the Cluster ID", @@ -152147,6 +152806,13 @@ "related": "addCluster", "required": true, "type": "uuid" + }, + { + "description": "Nexus port profile associated with inside interface of ASA 1000v", + "length": 255, + "name": "insideportprofile", + "required": true, + "type": "string" } ], "related": "", @@ -152154,19 +152820,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 +152841,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,107 +152855,100 @@ "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": "the physical network to which this Palo Alto firewall belongs to", + "name": "physicalnetworkid", "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 public security zone of the external firewall", - "name": "publiczone", + "description": "the UUID of the latest async 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 private security zone of the external firewall", - "name": "privatezone", + "description": "name of the provider", + "name": "provider", "type": "string" }, { - "description": "the number of times to retry requests to the external firewall", - "name": "numretries", + "description": "the management IP address of the external firewall", + "name": "ipaddress", "type": "string" }, { - "description": "the username that's used to log in to the external firewall", - "name": "username", + "description": "the private interface of the external firewall", + "name": "privateinterface", "type": "string" }, { - "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": "the management IP address of the external firewall", - "name": "ipaddress", + "description": "device id of the Palo Alto firewall", + "name": "fwdeviceid", "type": "string" }, { - "description": "device state", - "name": "fwdevicestate", + "description": "the public security zone of the external firewall", + "name": "publiczone", "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", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "device name", + "name": "fwdevicename", "type": "string" }, { - "description": "the physical network to which this Palo Alto firewall belongs to", - "name": "physicalnetworkid", + "description": "the zone ID of the external firewall", + "name": "zoneid", "type": "string" }, { - "description": "the zone ID of the external firewall", - "name": "zoneid", + "description": "device capacity", + "name": "fwdevicecapacity", + "type": "long" + }, + { + "description": "device state", + "name": "fwdevicestate", "type": "string" }, { - "description": "device id of the Palo Alto firewall", - "name": "fwdeviceid", + "description": "the private security zone of the external firewall", + "name": "privatezone", "type": "string" }, { - "description": "name of the provider", - "name": "provider", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the number of times to retry requests to the external firewall", + "name": "numretries", "type": "string" } ] @@ -152293,26 +152959,12 @@ "name": "updateNetworkACLItem", "params": [ { - "description": "A description indicating why the ACL rule is required.", + "description": "the traffic type for the ACL, can be Ingress or Egress, defaulted to Ingress if not specified", "length": 255, - "name": "reason", + "name": "traffictype", "required": false, "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" - }, { "description": "the protocol for the ACL rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number", "length": 255, @@ -152320,35 +152972,6 @@ "required": false, "type": "string" }, - { - "description": "scl entry action, allow or deny", - "length": 255, - "name": "action", - "required": false, - "type": "string" - }, - { - "description": "an optional field, whether to the display the rule to the end user or not", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" - }, - { - "description": "The network of the vm the ACL will be created for", - "length": 255, - "name": "number", - "required": false, - "type": "integer" - }, - { - "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 network ACL item", "length": 255, @@ -152358,11 +152981,11 @@ "type": "uuid" }, { - "description": "the ending port of ACL", + "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": "endport", + "name": "partialupgrade", "required": false, - "type": "integer" + "type": "boolean" }, { "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", @@ -152373,122 +152996,110 @@ "type": "string" }, { - "description": "the traffic type for the ACL, can be Ingress or Egress, defaulted to Ingress if not specified", - "length": 255, - "name": "traffictype", - "required": false, - "type": "string" - }, - { - "description": "error code for this ICMP message", + "description": "the cidr list to allow traffic from/to. Multiple entries must be separated by a single comma character (,).", "length": 255, - "name": "icmpcode", + "name": "cidrlist", "required": false, - "type": "integer" + "type": "list" }, { - "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": "A description indicating why the ACL rule is required.", "length": 255, - "name": "partialupgrade", + "name": "reason", "required": false, - "type": "boolean" - } - ], - "related": "moveNetworkAclItem", - "response": [ - { - "description": "the ID of the ACL this item belongs to", - "name": "aclid", - "type": "string" - }, - {}, - { - "description": "the state of the rule", - "name": "state", "type": "string" }, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", - "type": "string" - }, - { - "description": "Number of the ACL Item", - "name": "number", + "description": "the starting port of ACL", + "length": 255, + "name": "startport", + "required": false, "type": "integer" }, { - "description": "Action of ACL Item. Allow/Deny", - "name": "action", - "type": "string" + "description": "type of the ICMP message being sent", + "length": 255, + "name": "icmptype", + "required": false, + "type": "integer" }, { - "description": "the protocol of the ACL", - "name": "protocol", - "type": "string" + "description": "an optional field, whether to the display the rule to the end user or not", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" }, { - "description": "error code for this icmp message", - "name": "icmpcode", + "description": "the ending port of ACL", + "length": 255, + "name": "endport", + "required": false, "type": "integer" }, { - "description": "the ending port of ACL's port range", - "name": "endport", - "type": "string" + "description": "The network of the vm the ACL will be created for", + "length": 255, + "name": "number", + "required": false, + "type": "integer" }, { - "description": "an explanation on why this ACL rule is being applied", - "name": "reason", - "type": "string" + "description": "error code for this ICMP message", + "length": 255, + "name": "icmpcode", + "required": false, + "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "scl entry action, allow or deny", + "length": 255, + "name": "action", + "required": false, "type": "string" - }, + } + ], + "related": "moveNetworkAclItem", + "response": [ { - "description": "the name of the ACL this item belongs to", - "name": "aclname", + "description": "the starting port of ACL's port range", + "name": "startport", "type": "string" }, + {}, { "description": "the list of resource tags associated with the network ACLs", "name": "tags", "response": [ { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "tag value", - "name": "value", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the 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 domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -152497,44 +153108,79 @@ "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": "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" } ], "type": "list" }, { - "description": "the ID of the ACL Item", - "name": "id", + "description": "an explanation on why this ACL rule is being applied", + "name": "reason", "type": "string" }, { - "description": "the starting port of ACL's port range", - "name": "startport", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the ending port of ACL's port range", + "name": "endport", + "type": "string" + }, + { + "description": "Number of the ACL Item", + "name": "number", + "type": "integer" + }, + { + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", + "type": "string" }, {}, + { + "description": "Action of ACL Item. Allow/Deny", + "name": "action", + "type": "string" + }, { "description": "type of the icmp message being sent", "name": "icmptype", "type": "integer" }, + { + "description": "the name of the ACL this item belongs to", + "name": "aclname", + "type": "string" + }, + { + "description": "the ID of the ACL this item belongs to", + "name": "aclid", + "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", @@ -152544,6 +153190,26 @@ "description": "the traffic type for the ACL", "name": "traffictype", "type": "string" + }, + { + "description": "the state of the rule", + "name": "state", + "type": "string" + }, + { + "description": "the ID of the ACL Item", + "name": "id", + "type": "string" + }, + { + "description": "the protocol of the ACL", + "name": "protocol", + "type": "string" + }, + { + "description": "error code for this icmp message", + "name": "icmpcode", + "type": "integer" } ] }, @@ -152553,41 +153219,26 @@ "name": "listRouters", "params": [ { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "the cluster ID of the router", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "clusterid", - "related": "addCluster", + "name": "projectid", + "related": "", "required": false, "type": "uuid" }, { - "description": "List networks by VPC", + "description": "List by keyword", "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,updateVPC", + "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 virtual router elements by version", "length": 255, - "name": "listall", + "name": "version", "required": false, - "type": "boolean" + "type": "string" }, { "description": "the host ID of the router", @@ -152598,32 +153249,25 @@ "type": "uuid" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "the state of the router", "length": 255, - "name": "isrecursive", + "name": "state", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "the ID of the disk router", + "description": "List networks by VPC", "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": "vpcid", + "related": "createVPC,listVPCs,updateVPC", "required": false, "type": "uuid" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "list by network id", + "description": "the cluster ID of the router", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", + "name": "clusterid", + "related": "addCluster", "required": false, "type": "uuid" }, @@ -152636,13 +153280,21 @@ "type": "uuid" }, { - "description": "the Zone ID of the router", + "description": "list by network id", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", "required": false, "type": "uuid" }, + { + "description": "if true is passed for this parameter, also fetch last executed health check results for the router. Default is false", + "length": 255, + "name": "fetchhealthcheckresults", + "required": false, + "since": "4.14", + "type": "boolean" + }, { "description": "if true is passed for this parameter, list only VPC routers", "length": 255, @@ -152651,26 +153303,26 @@ "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 ID of the disk router", "length": 255, - "name": "fetchhealthcheckresults", + "name": "id", + "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,createVMFromBackup,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "required": false, - "since": "4.14", - "type": "boolean" + "type": "uuid" }, { - "description": "the name of the router", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources 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 resources by account. Must be used with the domainId parameter.", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "account", + "name": "isrecursive", "required": false, - "type": "string" + "type": "boolean" }, { "description": "the Pod ID of the router", @@ -152681,35 +153333,42 @@ "type": "uuid" }, { - "description": "the state of the router", + "description": "CPU arch of the router", "length": 255, - "name": "state", + "name": "arch", "required": false, + "since": "4.20.1", "type": "string" }, { - "description": "list virtual router elements by version", + "description": "", "length": 255, - "name": "version", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "the Zone ID of the router", "length": 255, - "name": "projectid", - "related": "", + "name": "zoneid", + "related": "listZones", "required": false, "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": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, { "description": "if this parameter is passed, list only routers by health check results", "length": 255, @@ -152717,86 +153376,67 @@ "required": false, "since": "4.16", "type": "boolean" + }, + { + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, + "type": "string" } ], "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", + "description": "path of the Domain the router belongs to", + "name": "domainpath", "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", + "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", + "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 type of the health check - basic or advanced", + "name": "checktype", + "type": "string" }, { - "description": "the name of the health check on the router", - "name": "checkname", - "type": "string" + "description": "the 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 date this VPC was created", + "name": "lastupdated", + "type": "date" } ], "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": "CPU arch of the router", + "name": "arch", "type": "string" }, - {}, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the gateway for the router", + "name": "gateway", "type": "string" }, { @@ -152805,90 +153445,85 @@ "type": "string" }, { - "description": "the version of template", - "name": "version", + "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": "the ID of the corresponding guest network", + "name": "guestnetworkid", "type": "string" }, { - "description": "the host ID for the router", - "name": "hostid", + "description": "the Zone ID for the router", + "name": "zoneid", "type": "string" }, { - "description": "the name of the corresponding guest network", - "name": "guestnetworkname", + "description": "the link local netmask for the router", + "name": "linklocalnetmask", "type": "string" }, { - "description": "the Pod name for the router", - "name": "podname", + "description": "the version of scripts", + "name": "scriptsversion", "type": "string" }, { - "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": "CPU arch of the router", - "name": "arch", + "description": "the hostname for the router", + "name": "hostname", "type": "string" }, - {}, { - "description": "the public MAC address for the router", - "name": "publicmacaddress", - "type": "string" + "description": "true if the router template requires upgrader", + "name": "requiresupgrade", + "type": "boolean" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" + "description": "the state of the router", + "name": "state", + "type": "state" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the control state of the host for the router", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the date and time the router was created", - "name": "created", - "type": "date" - }, - { - "description": "the state of the router", - "name": "state", - "type": "state" + "description": "the guest netmask for the router", + "name": "guestnetmask", + "type": "string" }, { - "description": "the Zone name for the router", - "name": "zonename", + "description": "VPC the router belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the Pod name for the router", + "name": "podname", "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "the domain associated with the router", - "name": "domain", + "description": "the version of the code / software in the router", + "name": "softwareversion", "type": "string" }, + {}, { - "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 state of redundant virtual router", @@ -152896,53 +153531,48 @@ "type": "string" }, { - "description": "the ID of the corresponding public network", - "name": "publicnetworkid", + "description": "the id of the router", + "name": "id", "type": "string" }, { - "description": "role of the domain router", - "name": "role", + "description": "the guest IP address for the router", + "name": "guestipaddress", "type": "string" }, { - "description": "the hostname for the router", - "name": "hostname", + "description": "the first DNS for the router", + "name": "dns1", "type": "string" }, { - "description": "true if the router template requires upgrader", - "name": "requiresupgrade", - "type": "boolean" - }, - { - "description": "the gateway for the router", - "name": "gateway", + "description": "the public MAC address for the router", + "name": "publicmacaddress", "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 Pod ID for the router", - "name": "podid", - "type": "string" + "description": "true if any health checks had failed", + "name": "healthchecksfailed", + "type": "boolean" }, { - "description": "VPC the router belongs to", - "name": "vpcid", + "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 project name of the address", + "name": "project", "type": "string" }, { - "description": "the guest IP address for the router", - "name": "guestipaddress", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { @@ -152951,83 +153581,58 @@ "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 template name for the router", - "name": "templatename", + "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 version of the code / software in the router", - "name": "softwareversion", + "description": "the host ID for the router", + "name": "hostid", "type": "string" }, { - "description": "the version of scripts", - "name": "scriptsversion", + "description": "the version of template", + "name": "version", "type": "string" }, { - "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 link local MAC address for the router", - "name": "linklocalmacaddress", + "description": "the name of the corresponding guest network", + "name": "guestnetworkname", "type": "string" }, { - "description": "the second DNS for the router", - "name": "dns2", + "description": "the first IPv6 DNS for the router", + "name": "ip6dns1", "type": "string" }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, { "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 network domain for the router", - "name": "networkdomain", - "type": "string" - }, - { - "description": "the domain ID associated with the router", - "name": "domainid", - "type": "string" - }, - { - "description": "the account associated with the router", - "name": "account", + "description": "the second IPv6 DNS for the router", + "name": "ip6dns2", "type": "string" }, { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", + "description": "the template name for the router", + "name": "templatename", "type": "string" }, { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", + "description": "the name of VPC the router belongs to", + "name": "vpcname", "type": "string" }, { @@ -153035,14 +153640,14 @@ "name": "nic", "response": [ { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" }, { "description": "the IPv6 address of network", @@ -153050,38 +153655,48 @@ "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "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": "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 ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { @@ -153090,43 +153705,48 @@ "type": "string" }, { - "description": "the ID of the nic", - "name": "id", - "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": "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 vpc to which the nic belongs", + "name": "vpcid", + "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the type of the nic", + "name": "type", "type": "string" }, { "description": "true if nic is default, false otherwise", - "name": "macaddress", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" }, { @@ -153140,57 +153760,108 @@ "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" - }, - { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "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", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the ID of the nic", + "name": "id", "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": "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", + "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": "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" } ], "type": "set" + }, + { + "description": "the Zone name for the router", + "name": "zonename", + "type": "string" + }, + { + "description": "role of the domain router", + "name": "role", + "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": "if this router is an redundant virtual router", + "name": "isredundantrouter", + "type": "boolean" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the public IP address for the router", + "name": "publicip", + "type": "string" + }, + {}, + { + "description": "the network domain for the router", + "name": "networkdomain", + "type": "string" + }, + { + "description": "the guest MAC address for the router", + "name": "guestmacaddress", + "type": "string" + }, + { + "description": "the domain associated with the router", + "name": "domain", + "type": "string" + }, + { + "description": "the public netmask for the router", + "name": "publicnetmask", + "type": "string" + }, + { + "description": "the template ID for the router", + "name": "templateid", + "type": "string" + }, + { + "description": "the account associated with the router", + "name": "account", + "type": "string" } ] }, @@ -153206,13 +153877,6 @@ "required": false, "type": "string" }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, { "description": "", "length": 255, @@ -153221,11 +153885,11 @@ "type": "integer" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { "description": "the ID of zone", @@ -153234,21 +153898,39 @@ "related": "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": "Tungsten-Fabric provider zone name", "name": "zonename", "type": "string" }, - {}, { "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", @@ -153258,18 +153940,7 @@ "description": "the UUID of the latest async 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 nic uuid", - "name": "uuid", - "type": "string" - }, - {} + } ] }, { @@ -153288,26 +153959,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": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ], "since": "3.0.0" @@ -153318,40 +153989,33 @@ "name": "addTungstenFabricPolicyRule", "params": [ { - "description": "Tungsten-Fabric policy rule source ip prefix", + "description": "Tungsten-Fabric policy rule destination ip prefix length", "length": 255, - "name": "srcipprefix", + "name": "destipprefixlen", "required": true, - "type": "string" + "type": "integer" }, { - "description": "Tungsten-Fabric policy rule direction", + "description": "Tungsten-Fabric policy rule source ip prefix", "length": 255, - "name": "direction", + "name": "srcipprefix", "required": true, "type": "string" }, { - "description": "Tungsten-Fabric policy rule destination network", + "description": "Tungsten-Fabric policy rule direction", "length": 255, - "name": "destnetwork", + "name": "direction", "required": true, "type": "string" }, { - "description": "Tungsten-Fabric policy rule destination ip prefix", + "description": "the uuid of Tungsten-Fabric policy", "length": 255, - "name": "destipprefix", + "name": "policyuuid", "required": true, "type": "string" }, - { - "description": "Tungsten-Fabric policy rule source end port", - "length": 255, - "name": "srcendport", - "required": true, - "type": "integer" - }, { "description": "Tungsten-Fabric policy rule source ip prefix length", "length": 255, @@ -153360,58 +154024,51 @@ "type": "integer" }, { - "description": "Tungsten-Fabric policy rule destination ip prefix length", - "length": 255, - "name": "destipprefixlen", - "required": true, - "type": "integer" - }, - { - "description": "Tungsten-Fabric policy rule destination start port", + "description": "Tungsten-Fabric policy rule source network", "length": 255, - "name": "deststartport", + "name": "srcnetwork", "required": true, - "type": "integer" + "type": "string" }, { - "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 action", "length": 255, - "name": "srcnetwork", + "name": "action", "required": true, "type": "string" }, { - "description": "Tungsten-Fabric policy rule protocol", + "description": "Tungsten-Fabric policy rule destination ip prefix", "length": 255, - "name": "protocol", + "name": "destipprefix", "required": true, "type": "string" }, { - "description": "the uuid of Tungsten-Fabric policy", + "description": "Tungsten-Fabric policy rule destination network", "length": 255, - "name": "policyuuid", + "name": "destnetwork", "required": true, "type": "string" }, { - "description": "Tungsten-Fabric policy rule action", + "description": "Tungsten-Fabric policy rule destination end port", "length": 255, - "name": "action", + "name": "destendport", "required": true, - "type": "string" + "type": "integer" }, { - "description": "Tungsten-Fabric policy rule destination end port", + "description": "Tungsten-Fabric policy rule source start port", "length": 255, - "name": "destendport", + "name": "srcstartport", "required": true, "type": "integer" }, @@ -153422,24 +154079,43 @@ "related": "listZones", "required": true, "type": "uuid" + }, + { + "description": "Tungsten-Fabric policy rule source end port", + "length": 255, + "name": "srcendport", + "required": true, + "type": "integer" + }, + { + "description": "Tungsten-Fabric policy rule destination start port", + "length": 255, + "name": "deststartport", + "required": true, + "type": "integer" } ], "related": "", "response": [ { - "description": "Tungsten-Fabric policy source ip prefix length", - "name": "srcipprefixlen", - "type": "int" + "description": "Tungsten-Fabric policy uuid", + "name": "policyuuid", + "type": "string" }, { - "description": "Tungsten-Fabric policy source network", - "name": "srcnetwork", + "description": "Tungsten-Fabric policy source ip prefix", + "name": "srcipprefix", "type": "string" }, { - "description": "Tungsten-Fabric policy destination start port", - "name": "deststartport", - "type": "int" + "description": "Tungsten-Fabric policy protocol", + "name": "protocol", + "type": "string" + }, + { + "description": "Tungsten-Fabric policy destination network", + "name": "destnetwork", + "type": "string" }, { "description": "Tungsten-Fabric policy destination end port", @@ -153447,13 +154123,13 @@ "type": "int" }, { - "description": "Tungsten-Fabric policy destination network", - "name": "destnetwork", - "type": "string" + "description": "Tungsten-Fabric policy source ip prefix length", + "name": "srcipprefixlen", + "type": "int" }, { - "description": "Tungsten-Fabric policy uuid", - "name": "policyuuid", + "description": "Tungsten-Fabric policy name", + "name": "direction", "type": "string" }, { @@ -153462,66 +154138,61 @@ "type": "string" }, { - "description": "Tungsten-Fabric policy source start port", - "name": "srcstartport", - "type": "int" - }, - { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" + "description": "Tungsten-Fabric policy action", + "name": "action", + "type": "string" }, { - "description": "Tungsten-Fabric policy name", - "name": "direction", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, { - "description": "Tungsten-Fabric policy protocol", - "name": "protocol", + "description": "Tungsten-Fabric policy source network", + "name": "srcnetwork", "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", - "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 policy destination ip prefix", "name": "destipprefix", "type": "string" }, + { + "description": "Tungsten-Fabric policy destination start port", + "name": "deststartport", + "type": "int" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, { - "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 action", - "name": "action", - "type": "string" + "description": "Tungsten-Fabric policy destination ip prefix length", + "name": "destipprefixlen", + "type": "int" }, - {}, { - "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" } ] }, @@ -153530,6 +154201,13 @@ "isasync": false, "name": "createWebhook", "params": [ + { + "description": "State of the Webhook", + "length": 255, + "name": "state", + "required": false, + "type": "string" + }, { "description": "Description for the Webhook", "length": 255, @@ -153538,47 +154216,48 @@ "type": "string" }, { - "description": "Name for the Webhook", + "description": "Secret key of the Webhook", "length": 255, - "name": "name", - "required": true, + "name": "secretkey", + "required": false, "type": "string" }, { - "description": "State of the Webhook", + "description": "Scope of the Webhook", "length": 255, - "name": "state", + "name": "scope", "required": false, "type": "string" }, { - "description": "If set to true then SSL verification will be done for the Webhook otherwise not", + "description": "Project for the Webhook", "length": 255, - "name": "sslverification", + "name": "projectid", + "related": "", "required": false, - "type": "boolean" + "type": "uuid" }, { - "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": "If set to true then SSL verification will be done for the Webhook otherwise not", "length": 255, - "name": "scope", + "name": "sslverification", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "an optional domainId for the Webhook. If the account parameter is used, domainId must also be used.", + "description": "Name for the Webhook", "length": 255, - "name": "domainid", - "related": "listDomains", - "required": false, - "type": "uuid" + "name": "name", + "required": true, + "type": "string" }, { "description": "An optional account for the Webhook. Must be used with domainId.", @@ -153593,57 +154272,44 @@ "name": "payloadurl", "required": true, "type": "string" - }, - { - "description": "Project for the Webhook", - "length": 255, - "name": "projectid", - "related": "", - "required": false, - "type": "uuid" } ], "related": "", "response": [ + {}, { - "description": "The state of the Webhook", - "name": "state", + "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 state of the Webhook", + "name": "state", + "type": "string" }, { "description": "The payload URL end point for the Webhook", "name": "payloadurl", "type": "string" }, - {}, - { - "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" }, { - "description": "The account associated with the Webhook", - "name": "account", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "The ID of the Webhook", - "name": "id", + "description": "The name of the Webhook", + "name": "name", "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" }, { @@ -153651,46 +154317,51 @@ "name": "jobstatus", "type": "integer" }, + {}, { - "description": "The ID of the domain in which the Webhook exists", - "name": "domainid", + "description": "The description of the Webhook", + "name": "description", "type": "string" }, { - "description": "The secret key for the Webhook", - "name": "secretkey", - "type": "string" + "description": "Whether SSL verification is enabled for the Webhook", + "name": "sslverification", + "type": "boolean" + }, + { + "description": "The date when this Webhook was created", + "name": "created", + "type": "date" }, { "description": "the project name of the Kubernetes cluster", "name": "project", "type": "string" }, - {}, { - "description": "the project id of the Kubernetes cluster", - "name": "projectid", + "description": "The scope of the Webhook", + "name": "scope", "type": "string" }, { - "description": "The scope of the Webhook", - "name": "scope", + "description": "The secret key for the Webhook", + "name": "secretkey", "type": "string" }, { - "description": "The name of the domain in which the Webhook exists", - "name": "domain", + "description": "The ID of the Webhook", + "name": "id", "type": "string" }, { - "description": "path of the domain to which the Webhook belongs", - "name": "domainpath", + "description": "The ID of the domain in which the Webhook exists", + "name": "domainid", "type": "string" }, { - "description": "The date when this Webhook was created", - "name": "created", - "type": "date" + "description": "The account associated with the Webhook", + "name": "account", + "type": "string" } ], "since": "4.20.0" @@ -153701,18 +154372,10 @@ "name": "removeVpnUser", "params": [ { - "description": "remove vpn user from the project", + "description": "an optional account for the vpn user. Must be used with domainId.", "length": 255, - "name": "projectid", - "related": "", + "name": "account", "required": false, - "type": "uuid" - }, - { - "description": "username for the vpn user", - "length": 255, - "name": "username", - "required": true, "type": "string" }, { @@ -153724,15 +154387,22 @@ "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": "uuid" + }, + { + "description": "username for the vpn user", + "length": 255, + "name": "username", + "required": true, "type": "string" } ], "response": [ - {}, { "description": "true if operation is executed successfully", "name": "success", @@ -153744,16 +154414,17 @@ "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" - } + {} ] }, { @@ -153762,99 +154433,99 @@ "name": "listQuarantinedIps", "params": [ { - "description": "Show IPs that are no longer in quarantine.", + "description": "Show IPs removed from quarantine.", "length": 255, - "name": "showinactive", + "name": "showremoved", "required": false, "type": "boolean" }, { - "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": "Show IPs removed from quarantine.", + "description": "Show IPs that are no longer in quarantine.", "length": 255, - "name": "showremoved", + "name": "showinactive", "required": false, "type": "boolean" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" } ], "related": "updateQuarantinedIp", "response": [ - {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "ID of the quarantine process.", "name": "id", "type": "string" }, { - "description": "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": "When the quarantine was removed.", - "name": "removed", - "type": "date" - }, - { - "description": "End date for the quarantine.", - "name": "enddate", - "type": "date" + "description": "The public IP address in quarantine.", + "name": "ipaddress", + "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": "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", - "type": "string" + "description": "End date for the quarantine.", + "name": "enddate", + "type": "date" }, {}, { - "description": "The public IP address in quarantine.", - "name": "ipaddress", + "description": "ID of the account that removed the IP from quarantine.", + "name": "removeraccountid", "type": "string" }, { - "description": "ID of the account that removed the IP from quarantine.", - "name": "removeraccountid", + "description": "Account 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" + }, + { + "description": "When the quarantine was removed.", + "name": "removed", + "type": "date" } ], "since": "4.19" @@ -153874,16 +154545,72 @@ } ], "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" + } + ], + "since": "4.2.0" + }, + { + "description": "Disables HA for a host", + "isasync": true, + "name": "disableHAForHost", + "params": [ + { + "description": "ID of the host", + "length": 255, + "name": "hostid", + "related": "reconnectHost", + "required": true, + "type": "uuid" + } + ], + "related": "", + "response": [ + { + "description": "the ID of the host", + "name": "hostid", + "type": "string" + }, + { + "description": "the host HA provider", + "name": "haprovider", + "type": "string" + }, + { + "description": "if host HA is enabled for the host", + "name": "haenable", + "type": "boolean" + }, + {}, + { + "description": "the HA state of the host", + "name": "hastate", + "type": "hastate" + }, + { + "description": "operation status", + "name": "status", + "type": "boolean" }, { "description": "the current status of the latest async job acting on this object", @@ -153891,26 +154618,19 @@ "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" }, {} ], - "since": "4.2.0" + "since": "4.11" }, { "description": "List Swift.", "isasync": false, "name": "listSwifts", "params": [ - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, { "description": "", "length": 255, @@ -153931,50 +154651,41 @@ "name": "pagesize", "required": false, "type": "integer" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" } ], "related": "", "response": [ { - "description": "the Zone ID of the image store", - "name": "zoneid", - "type": "string" - }, - { - "description": "the url of the image store", - "name": "url", + "description": "the name of the image store", + "name": "name", "type": "string" }, { - "description": "the provider name of the image store", - "name": "providername", + "description": "the protocol of the image store", + "name": "protocol", "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 ID of the image store", "name": "id", "type": "string" }, { - "description": "the protocol of the image store", - "name": "protocol", + "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 url of the image store", + "name": "url", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", @@ -153982,21 +154693,10 @@ "type": "integer" }, { - "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 scope of the image store", + "name": "scope", + "type": "scopetype" }, - {}, { "description": "the Zone name of the image store", "name": "zonename", @@ -154006,65 +154706,36 @@ "description": "defines if store is read-only", "name": "readonly", "type": "boolean" - } - ], - "since": "3.0.0" - }, - { - "description": "Disables HA for a host", - "isasync": true, - "name": "disableHAForHost", - "params": [ - { - "description": "ID of the host", - "length": 255, - "name": "hostid", - "related": "reconnectHost", - "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 host HA provider", - "name": "haprovider", + "description": "the provider name of the image store", + "name": "providername", "type": "string" }, { - "description": "if host HA is enabled for the host", - "name": "haenable", - "type": "boolean" + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" }, { - "description": "the ID of the host", - "name": "hostid", - "type": "string" + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" }, { - "description": "operation status", - "name": "status", + "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 HA state of the host", - "name": "hastate", - "type": "hastate" - }, - {} + } ], - "since": "4.11" + "since": "3.0.0" }, { "description": "Enables out-of-band management for a host", @@ -154082,16 +154753,14 @@ ], "related": "", "response": [ - {}, - {}, { - "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 out-of-band management interface username", - "name": "username", + "description": "the out-of-band management interface port", + "name": "port", "type": "string" }, { @@ -154100,53 +154769,55 @@ "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": "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 operation result description", + "name": "description", + "type": "string" }, + {}, { "description": "the ID of the host", "name": "hostid", "type": "string" }, + {}, { - "description": "the out-of-band management action (if issued)", - "name": "action", - "type": "string" + "description": "true if out-of-band management is enabled for the host", + "name": "enabled", + "type": "boolean" }, { "description": "the out-of-band management driver for the host", "name": "driver", "type": "string" }, + { + "description": "the out-of-band management action (if issued)", + "name": "action", + "type": "string" + }, { "description": "the 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 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 out-of-band management interface address", + "name": "address", "type": "string" } ], @@ -154173,6 +154844,12 @@ "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", @@ -154182,13 +154859,7 @@ "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" - }, - {} + } ] }, { @@ -154197,82 +154868,84 @@ "name": "listKubernetesSupportedVersions", "params": [ { - "description": "the CPU arch of the binaries ISO. Valid options are: x86_64, aarch64", + "description": "", "length": 255, - "name": "arch", + "name": "page", "required": false, - "since": "4.20", - "type": "string" + "type": "integer" }, { - "description": "the ID of the minimum Kubernetes supported version", + "description": "the ID of the zone in which Kubernetes supported version will be available", "length": 255, - "name": "minimumkubernetesversionid", - "related": "listKubernetesSupportedVersions", + "name": "zoneid", + "related": "listZones", "required": false, "type": "uuid" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "the ID of the zone in which Kubernetes supported version will be available", + "description": "the ID of the Kubernetes supported version", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "id", + "related": "getUploadParamsForKubernetesSupportedVersion,listKubernetesSupportedVersions", "required": false, "type": "uuid" }, { - "description": "", + "description": "the ID of the minimum Kubernetes supported version", "length": 255, - "name": "page", + "name": "minimumkubernetesversionid", + "related": "getUploadParamsForKubernetesSupportedVersion,listKubernetesSupportedVersions", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "", + "description": "the minimum semantic version for the Kubernetes supported version to be listed", "length": 255, - "name": "pagesize", + "name": "minimumsemanticversion", "required": false, - "type": "integer" + "type": "string" }, { - "description": "the minimum semantic version for the Kubernetes supported version to be listed", + "description": "the CPU arch of the binaries ISO. Valid options are: x86_64, aarch64", "length": 255, - "name": "minimumsemanticversion", + "name": "arch", "required": false, + "since": "4.20", "type": "string" }, { - "description": "the ID of the Kubernetes supported version", + "description": "List by keyword", "length": 255, - "name": "id", - "related": "listKubernetesSupportedVersions", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" } ], - "related": "", + "related": "getUploadParamsForKubernetesSupportedVersion", "response": [ { - "description": "the minimum RAM size in MB needed for the Kubernetes supported version", - "name": "minmemory", - "type": "integer" + "description": "the id of the Kubernetes supported version", + "name": "id", + "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": "the id of the zone in which Kubernetes supported version is available", - "name": "zoneid", - "type": "string" + "description": "the minimum number of CPUs needed for the Kubernetes supported version", + "name": "mincpunumber", + "type": "integer" }, { "description": "the current status of the latest async job acting on this object", @@ -154280,50 +154953,43 @@ "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", + "description": "the id of the zone in which Kubernetes supported version is available", + "name": "zoneid", "type": "string" }, { - "description": "the id of the binaries ISO for Kubernetes supported version", - "name": "isoid", - "type": "string" + "description": "the minimum RAM size in MB needed for the Kubernetes supported version", + "name": "minmemory", + "type": "integer" }, - {}, { - "description": "whether Kubernetes supported version supports Autoscaling", - "name": "supportsautoscaling", + "description": "whether Kubernetes supported version supports HA, multi-control nodes", + "name": "supportsha", "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", - "type": "integer" + "description": "the enabled or disabled state of the Kubernetes supported version", + "name": "state", + "type": "string" }, - {}, { - "description": "the name of the binaries ISO for Kubernetes supported version", - "name": "isoname", + "description": "Name of the Kubernetes supported version", + "name": "name", "type": "string" }, { @@ -154332,8 +154998,8 @@ "type": "string" }, { - "description": "the name of the zone in which Kubernetes supported version is available", - "name": "zonename", + "description": "the id of the binaries ISO for Kubernetes supported version", + "name": "isoid", "type": "string" }, { @@ -154341,15 +155007,20 @@ "name": "created", "type": "date" }, + { + "description": "KVM Only: true if the ISO for the Kubernetes supported version is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", + "type": "boolean" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "KVM Only: true if the ISO for the Kubernetes supported version is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", - "type": "boolean" + "description": "Kubernetes semantic version", + "name": "semanticversion", + "type": "string" } ] }, @@ -154359,10 +155030,10 @@ "name": "addNiciraNvpDevice", "params": [ { - "description": "The Transportzone UUID configured on the Nicira Controller", + "description": "The L3 Gateway Service UUID configured on the Nicira Controller", "length": 255, - "name": "transportzoneuuid", - "required": true, + "name": "l3gatewayserviceuuid", + "required": false, "type": "string" }, { @@ -154372,6 +155043,21 @@ "required": true, "type": "string" }, + { + "description": "The Transportzone UUID configured on the Nicira Controller", + "length": 255, + "name": "transportzoneuuid", + "required": true, + "type": "string" + }, + { + "description": "the Physical Network ID", + "length": 255, + "name": "physicalnetworkid", + "related": "", + "required": true, + "type": "uuid" + }, { "description": "The L2 Gateway Service UUID configured on the Nicira Controller", "length": 255, @@ -154392,65 +155078,40 @@ "name": "username", "required": true, "type": "string" - }, - { - "description": "The L3 Gateway Service UUID configured on the Nicira Controller", - "length": 255, - "name": "l3gatewayserviceuuid", - "required": false, - "type": "string" - }, - { - "description": "the Physical Network ID", - "length": 255, - "name": "physicalnetworkid", - "related": "", - "required": true, - "type": "uuid" } ], "related": "", "response": [ - { - "description": "the physical network to which this Nirica Nvp belongs to", - "name": "physicalnetworkid", - "type": "string" - }, + {}, { "description": "device name", "name": "niciradevicename", "type": "string" }, { - "description": "this L3 gateway service Uuid", - "name": "l3gatewayserviceuuid", + "description": "the physical network to which this Nirica Nvp belongs to", + "name": "physicalnetworkid", "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": "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": "this L2 gateway service Uuid", - "name": "l2gatewayserviceuuid", + "description": "name of the provider", + "name": "provider", "type": "string" }, { - "description": "name of the provider", - "name": "provider", + "description": "the transport zone Uuid", + "name": "transportzoneuuid", "type": "string" }, { @@ -154459,8 +155120,18 @@ "type": "string" }, { - "description": "the transport zone Uuid", - "name": "transportzoneuuid", + "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", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ] @@ -154472,76 +155143,81 @@ "params": [], "related": "", "response": [ - {}, { - "description": "Number of storage pools", - "name": "storagepools", + "description": "Number of pods", + "name": "pods", "type": "integer" }, + {}, { - "description": "Number of images stores", - "name": "imagestores", + "description": "Number of clusters", + "name": "clusters", "type": "integer" }, { - "description": "Number of pods", - "name": "pods", + "description": "Number of routers", + "name": "routers", "type": "integer" }, { - "description": "Number of hypervisor hosts", - "name": "hosts", + "description": "the UUID of the latest async 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": "Number of internal LBs", - "name": "ilbvms", + "description": "Number of systemvms", + "name": "systemvms", "type": "integer" }, + {}, { - "description": "Number of management servers", - "name": "managementservers", + "description": "Number of zones", + "name": "zones", "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "Number of images stores", + "name": "imagestores", + "type": "integer" }, { - "description": "Number of cpu sockets", - "name": "cpusockets", + "description": "Number of management servers", + "name": "managementservers", "type": "integer" }, { - "description": "Number of Alerts", - "name": "alerts", + "description": "Number of internal LBs", + "name": "ilbvms", "type": "integer" }, { - "description": "Number of clusters", - "name": "clusters", + "description": "Number of hypervisor hosts", + "name": "hosts", "type": "integer" }, { - "description": "Number of routers", - "name": "routers", + "description": "Number of cpu sockets", + "name": "cpusockets", "type": "integer" }, { - "description": "Number of zones", - "name": "zones", + "description": "Number of backup repositories", + "name": "backuprepositories", "type": "integer" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "Number of Alerts", + "name": "alerts", "type": "integer" }, { - "description": "Number of systemvms", - "name": "systemvms", + "description": "Number of storage pools", + "name": "storagepools", "type": "integer" }, { @@ -154557,28 +155233,6 @@ "isasync": false, "name": "listUsageRecords", "params": [ - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "List usage records for specified project", - "length": 255, - "name": "projectid", - "related": "", - "required": false, - "type": "uuid" - }, { "description": "List usage records for the specified domain.", "length": 255, @@ -154590,7 +155244,7 @@ { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, @@ -154602,19 +155256,26 @@ "type": "date" }, { - "description": "List usage records for the specified account", + "description": "List usage records for the specified user.", "length": 255, - "name": "accountid", - "related": "enableAccount,listAccounts", + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "List usage records for specified project", + "length": 255, + "name": "projectid", + "related": "", "required": false, "type": "uuid" }, { - "description": "List usage records for the specified user.", + "description": "List usage records for the specified usage type", "length": 255, - "name": "account", + "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,11 +155292,26 @@ "type": "date" }, { - "description": "List usage records for the specified usage type", + "description": "", "length": 255, - "name": "type", + "name": "pagesize", "required": false, - "type": "long" + "type": "integer" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "Specify if usage records should be fetched recursively per domain. If an account id is passed, records will be limited to that account.", + "length": 255, + "name": "isrecursive", + "required": false, + "since": "4.15", + "type": "boolean" }, { "description": "Flag to enable description rendered in old format which uses internal database IDs instead of UUIDs. False by default.", @@ -154652,40 +155328,75 @@ "type": "boolean" }, { - "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 account", "length": 255, - "name": "isrecursive", + "name": "accountid", + "related": "enableAccount,listAccounts", "required": false, - "since": "4.15", - "type": "boolean" + "type": "uuid" } ], "related": "", "response": [ { - "description": "the user account name", - "name": "account", + "description": "usage type ID", + "name": "usagetype", + "type": "integer" + }, + { + "description": "resource or virtual machine name", + "name": "name", + "type": "string" + }, + { + "description": "resource type", + "name": "type", "type": "string" }, + { + "description": "resource size", + "name": "size", + "type": "long" + }, + {}, { "description": "virtual machine os type ID", "name": "ostypeid", "type": "string" }, { - "description": "end date of the usage record", - "name": "enddate", - "type": "date" + "description": "the user account name", + "name": "account", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "template ID", + "name": "templateid", + "type": "string" + }, + { + "description": "id of the resource", + "name": "usageid", + "type": "string" }, - {}, { "description": "the domain ID", "name": "domainid", "type": "string" }, { - "description": "resource size", - "name": "size", + "description": "the zone ID", + "name": "zoneid", + "type": "string" + }, + { + "description": "memory allocated for the resource", + "name": "memory", "type": "long" }, { @@ -154694,8 +155405,58 @@ "type": "string" }, { - "description": "the project name of the resource", - "name": "project", + "description": "virtual machine guest os category ID", + "name": "oscategoryid", + "type": "string" + }, + { + "description": "end date of the usage record", + "name": "enddate", + "type": "date" + }, + { + "description": "usage in hours", + "name": "usage", + "type": "string" + }, + { + "description": "True if the IPAddress is source NAT", + "name": "issourcenat", + "type": "boolean" + }, + { + "description": "raw usage in hours", + "name": "rawusage", + "type": "string" + }, + { + "description": "True if the resource is default", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the user account Id", + "name": "accountid", + "type": "string" + }, + { + "description": "start date of the usage record", + "name": "startdate", + "type": "date" + }, + { + "description": "True if the IPAddress is system IP - allocated during vm deploy or lb rule create", + "name": "issystem", + "type": "boolean" + }, + { + "description": "description of the usage record", + "name": "description", + "type": "string" + }, + { + "description": "id of the vpc", + "name": "vpcid", "type": "string" }, { @@ -154703,23 +155464,18 @@ "name": "tags", "response": [ { - "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": "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" }, { @@ -154733,8 +155489,8 @@ "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -154743,13 +155499,18 @@ "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": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "tag value", + "name": "value", "type": "string" }, { @@ -154761,104 +155522,18 @@ "type": "set" }, { - "description": "id of the network", - "name": "networkid", - "type": "string" - }, - { - "description": "template ID", - "name": "templateid", - "type": "string" - }, - { - "description": "number of cpu of resource", - "name": "cpunumber", - "type": "long" - }, - { - "description": "description of the usage record", - "name": "description", - "type": "string" - }, - { - "description": "id of the vpc", - "name": "vpcid", - "type": "string" - }, - { - "description": "the zone ID", - "name": "zoneid", - "type": "string" - }, - { - "description": "raw usage in hours", - "name": "rawusage", - "type": "string" - }, - { - "description": "True if the resource is default", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "virtual machine guest os category ID", - "name": "oscategoryid", - "type": "string" - }, - { - "description": "usage type ID", - "name": "usagetype", - "type": "integer" - }, - {}, - { - "description": "the user account Id", - "name": "accountid", - "type": "string" - }, - { - "description": "usage in hours", - "name": "usage", - "type": "string" - }, - { - "description": "resource type", - "name": "type", - "type": "string" - }, - { - "description": "speed of each cpu of resource", - "name": "cpuspeed", - "type": "long" - }, - { - "description": "True if the IPAddress is source NAT", - "name": "issourcenat", - "type": "boolean" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "virtual size of resource", - "name": "virtualsize", - "type": "long" - }, - { - "description": "memory allocated for the resource", - "name": "memory", - "type": "long" + "description": "virtual machine ID", + "name": "virtualmachineid", + "type": "string" }, { - "description": "resource or virtual machine name", - "name": "name", - "type": "string" + "description": "virtual size of resource", + "name": "virtualsize", + "type": "long" }, { - "description": "id of the resource", - "name": "usageid", + "description": "id of the network", + "name": "networkid", "type": "string" }, { @@ -154867,29 +155542,35 @@ "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "speed of each cpu of resource", + "name": "cpuspeed", + "type": "long" }, + {}, { - "description": "the project id of the resource", - "name": "projectid", + "description": "offering ID", + "name": "offeringid", "type": "string" }, + { + "description": "number of cpu of resource", + "name": "cpunumber", + "type": "long" + }, { "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": "the project id of the resource", + "name": "projectid", + "type": "string" }, { - "description": "path of the domain to which the usage reocrd belongs", - "name": "domainpath", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { "description": "virtual machine os display name", @@ -154897,18 +155578,13 @@ "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", + "description": "the project name of the resource", + "name": "project", "type": "string" }, { - "description": "offering ID", - "name": "offeringid", + "description": "path of the domain to which the usage reocrd belongs", + "name": "domainpath", "type": "string" } ] @@ -154930,18 +155606,43 @@ "related": "createVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "response": [ { - "description": "the project name of the vpn", - "name": "project", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "type": "long" + }, + { + "description": "the path of the volume", + "name": "path", "type": "string" }, { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", + "description": "ID of the disk volume", + "name": "id", + "type": "string" + }, + { + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", + "type": "boolean" + }, + { + "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", "type": "string" }, { @@ -154950,63 +155651,78 @@ "type": "string" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", + "type": "boolean" + }, + { + "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": "details for the volume repair result, they may vary for different hypervisors", - "name": "volumerepairresult", - "type": "map" + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "id of the virtual machine", + "name": "virtualmachineid", + "type": "string" }, { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", + "description": "the bytes actually consumed on disk", + "name": "physicalsize", "type": "long" }, { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", + "description": "the domain associated with the disk volume", + "name": "domain", + "type": "string" + }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", + "description": "pod id of the volume", + "name": "podid", "type": "string" }, { - "description": "max iops of the disk volume", - "name": "maxiops", + "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", + "name": "deviceid", "type": "long" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", - "type": "string" + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "type": "long" }, { - "description": "true if volume has delete protection.", - "name": "deleteprotection", - "type": "boolean" + "description": "name of the disk offering", + "name": "diskofferingname", + "type": "string" }, { - "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 ID of the domain associated with the disk volume", - "name": "domainid", + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "name of the disk volume", + "name": "name", "type": "string" }, { @@ -155015,13 +155731,69 @@ "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "pod name of the volume", + "name": "podname", + "type": "string" }, { - "description": "the disk utilization", - "name": "utilization", + "description": "ID of the availability zone", + "name": "zoneid", + "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": "cluster id of the volume", + "name": "clusterid", + "type": "string" + }, + { + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" + }, + { + "description": "name of the virtual machine", + "name": "vmname", + "type": "string" + }, + { + "description": "name of the primary storage hosting the disk volume", + "name": "storage", + "type": "string" + }, + { + "description": "the chain info of the volume", + "name": "chaininfo", + "type": "string" + }, + { + "description": "cluster name where the volume is allocated", + "name": "clustername", + "type": "string" + }, + { + "description": "size of the disk volume", + "name": "size", + "type": "long" + }, + { + "description": "the bytes allocated", + "name": "virtualsize", + "type": "long" + }, + {}, + { + "description": "path of the Domain the disk volume belongs to", + "name": "domainpath", "type": "string" }, { @@ -155030,32 +155802,37 @@ "type": "string" }, { - "description": "min iops of the disk volume", - "name": "miniops", - "type": "long" + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", + "type": "string" + }, + { + "description": "details for the volume repair result, they may vary for different hypervisors", + "name": "volumerepairresult", + "type": "map" }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "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": "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": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -155064,198 +155841,111 @@ "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": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "set" }, - { - "description": "the project id of the vpn", - "name": "projectid", - "type": "string" - }, - { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", - "type": "string" - }, - { - "description": "ID of the availability zone", - "name": "zoneid", - "type": "string" - }, - { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" - }, - { - "description": "type of the virtual machine", - "name": "vmtype", - "type": "string" - }, - { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" - }, - { - "description": "the chain info of the volume", - "name": "chaininfo", - "type": "string" - }, - { - "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": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", - "type": "boolean" - }, - { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", - "type": "boolean" - }, - {}, - { - "description": "the bytes allocated", - "name": "virtualsize", - "type": "long" - }, - { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", + "description": "the read (IO) of disk on the vm", + "name": "diskioread", "type": "long" }, { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" - }, - { - "description": "name of the disk volume", - "name": "name", + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" }, { - "description": "pod id of the volume", - "name": "podid", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", + "description": "max iops of the disk volume", + "name": "maxiops", "type": "long" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", - "type": "boolean" - }, - { - "description": "cluster name where the volume is allocated", - "name": "clustername", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "display name of the virtual machine", + "name": "vmdisplayname", "type": "string" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "description": "shared or local storage", + "name": "storagetype", "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", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "ID of the disk volume", - "name": "id", - "type": "string" - }, - { - "description": "name of the virtual machine", - "name": "vmname", - "type": "string" + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" }, { - "description": "the path of the volume", - "name": "path", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "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": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" - }, - { - "description": "the format of the disk encryption if applicable", - "name": "encryptformat", + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { @@ -155264,8 +155954,8 @@ "type": "string" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { @@ -155274,23 +155964,24 @@ "type": "long" }, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", - "type": "string" + "description": "true if volume has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, + {}, { - "description": "details for the volume check result, they may vary for different hypervisors", - "name": "volumecheckresult", - "type": "map" + "description": "the date the disk volume was created", + "name": "created", + "type": "date" }, { - "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": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { @@ -155299,58 +155990,43 @@ "type": "string" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", + "description": "the disk utilization", + "name": "utilization", "type": "string" }, { - "description": "name of the availability zone", - "name": "zonename", - "type": "string" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "shared or local storage", - "name": "storagetype", + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", "type": "string" }, { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" - }, - { - "description": "pod name of the volume", - "name": "podname", - "type": "string" + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", + "description": "the format of the disk encryption if applicable", + "name": "encryptformat", "type": "string" }, { - "description": "cluster id of the volume", - "name": "clusterid", + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", "type": "string" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" - }, - { - "description": "size of the disk volume", - "name": "size", - "type": "long" - }, - { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "type of the virtual machine", + "name": "vmtype", "type": "string" }, { - "description": "path of the Domain the disk volume belongs to", - "name": "domainpath", + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" } ], @@ -155362,12 +156038,11 @@ "name": "removeTungstenFabricNetworkGatewayFromLogicalRouter", "params": [ { - "description": "the ID of zone", + "description": "Tungsten-Fabric network uuid", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "networkuuid", "required": true, - "type": "uuid" + "type": "string" }, { "description": "Tungsten-Fabric logical router uuid", @@ -155377,52 +156052,53 @@ "type": "string" }, { - "description": "Tungsten-Fabric network uuid", + "description": "the ID of zone", "length": 255, - "name": "networkuuid", + "name": "zoneid", + "related": "listZones", "required": true, - "type": "string" + "type": "uuid" } ], "related": "", "response": [ + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "list Tungsten-Fabric policy network name", + "name": "network", + "type": "list" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" - }, + {}, { "description": "Tungsten-Fabric logical router uuid", "name": "uuid", "type": "string" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", - "type": "string" - }, { "description": "Tungsten-Fabric logical router name", "name": "name", "type": "string" }, { - "description": "list Tungsten-Fabric policy network name", - "name": "network", - "type": "list" + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" }, - {}, - {} + { + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", + "type": "string" + } ] }, { @@ -155440,22 +156116,14 @@ { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, - { - "description": "the ID of the storage pool", - "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance", - "required": true, - "type": "uuid" - }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, @@ -155465,30 +156133,42 @@ "name": "keyword", "required": false, "type": "string" + }, + { + "description": "the ID of the storage pool", + "length": 255, + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance", + "required": true, + "type": "uuid" } ], "related": "", "response": [ - {}, { - "description": "the full path of the volume", - "name": "fullpath", + "description": "the format of the volume", + "name": "format", "type": "string" }, { - "description": "id of the primary storage hosting the volume", - "name": "storageid", + "description": "volume details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "the path of the volume", + "name": "path", "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": "the chain info of the volume", + "name": "chaininfo", + "type": "string" }, { "description": "name of the primary storage hosting the volume", @@ -155497,50 +156177,46 @@ }, {}, { - "description": "volume 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 virtual size of the volume", - "name": "virtualsize", + "description": "the size of the volume", + "name": "size", "type": "long" }, { - "description": "the format of the volume", - "name": "format", - "type": "string" - }, - { - "description": "the path of the volume", - "name": "path", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the encrypt format of the volume", + "name": "encryptformat", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the virtual size of the volume", + "name": "virtualsize", + "type": "long" }, { - "description": "the name of the volume", - "name": "name", + "description": "id of the primary storage hosting the volume", + "name": "storageid", "type": "string" }, { - "description": "the chain info of the volume", - "name": "chaininfo", + "description": "type of the primary storage hosting the volume", + "name": "storagetype", "type": "string" }, { - "description": "the encrypt format of the volume", - "name": "encryptformat", + "description": "the name of the volume", + "name": "name", "type": "string" - } + }, + {} ], "since": "4.19.1" }, @@ -155550,13 +156226,36 @@ "name": "listZonesMetrics", "params": [ { - "description": "the name of the storage access group", + "description": "the ID of the zone", "length": 255, - "name": "storageaccessgroup", + "name": "id", + "related": "listZones", + "required": false, + "type": "uuid" + }, + { + "description": "the name of the zone", + "length": 255, + "name": "name", "required": false, - "since": "4.21.0", "type": "string" }, + { + "description": "the IDs of the zones, mutually exclusive with id", + "length": 255, + "name": "ids", + "related": "listZones", + "required": false, + "since": "4.19.0", + "type": "list" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, { "description": "flag to display the capacity of the zones", "length": 255, @@ -155565,12 +156264,12 @@ "type": "boolean" }, { - "description": "List zones by resource tags (key/value pairs)", + "description": "the ID of the domain associated with the zone", "length": 255, - "name": "tags", + "name": "domainid", + "related": "listDomains", "required": false, - "since": "4.3", - "type": "map" + "type": "uuid" }, { "description": "List by keyword", @@ -155580,11 +156279,11 @@ "type": "string" }, { - "description": "", + "description": "flag to display the resource image for the zones", "length": 255, - "name": "page", + "name": "showicon", "required": false, - "type": "integer" + "type": "boolean" }, { "description": "", @@ -155594,42 +156293,27 @@ "type": "integer" }, { - "description": "the network type of the zone that the virtual machine belongs to", + "description": "the name of the storage access group", "length": 255, - "name": "networktype", + "name": "storageaccessgroup", "required": false, + "since": "4.21.0", "type": "string" }, { - "description": "the ID of the domain associated with the zone", - "length": 255, - "name": "domainid", - "related": "listDomains", - "required": false, - "type": "uuid" - }, - { - "description": "the IDs of the zones, mutually exclusive with id", - "length": 255, - "name": "ids", - "related": "listZones", - "required": false, - "since": "4.19.0", - "type": "list" - }, - { - "description": "the name of the zone", + "description": "the network type of the zone that the virtual machine belongs to", "length": 255, - "name": "name", + "name": "networktype", "required": false, "type": "string" }, { - "description": "flag to display the resource image for the zones", + "description": "List zones by resource tags (key/value pairs)", "length": 255, - "name": "showicon", + "name": "tags", "required": false, - "type": "boolean" + "since": "4.3", + "type": "map" }, { "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.", @@ -155637,61 +156321,114 @@ "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 total cpu used in GiB", + "name": "memoryused", "type": "string" }, { - "description": "memory allocated disable threshold exceeded", - "name": "memoryallocateddisablethreshold", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the total cpu capacity in Ghz", + "name": "cputotal", + "type": "string" + }, + { + "description": "the guest CIDR address for the Zone", + "name": "guestcidraddress", + "type": "string" + }, + { + "description": "the total cpu capacity in GiB", + "name": "memorytotal", + "type": "string" + }, + { + "description": "the first internal DNS for the Zone", + "name": "internaldns1", + "type": "string" + }, + { + "description": "the network type of the zone; can be Basic or Advanced", + "name": "networktype", + "type": "string" + }, + { + "description": "memory usage notification threshold exceeded", + "name": "memorythreshold", "type": "boolean" }, { - "description": "comma-separated list of storage access groups for the zone", - "name": "storageaccessgroups", + "description": "Total GPUs in the Zone", + "name": "gputotal", + "type": "long" + }, + { + "description": "the UUID of the containing domain, null for public zones", + "name": "domainid", "type": "string" }, { - "description": "the maximum memory deviation", - "name": "memorymaxdeviation", + "description": "Meta data associated with the zone (key/value pairs)", + "name": "resourcedetails", + "type": "map" + }, + { + "description": "state of the cluster", + "name": "state", "type": "string" }, + {}, { - "description": "External network provider if any", - "name": "provider", + "description": "the allocation state of the cluster", + "name": "allocationstate", "type": "string" }, { - "description": "the second internal DNS for the Zone", - "name": "internaldns2", + "description": "Zone description", + "name": "description", "type": "string" }, { - "description": "cpu allocated notification threshold exceeded", - "name": "cpuallocatedthreshold", + "description": "the display text of the zone", + "name": "displaytext", + "type": "string" + }, + { + "description": "cpu usage disable threshold exceeded", + "name": "cpudisablethreshold", "type": "boolean" }, { - "description": "cpu usage notification threshold exceeded", - "name": "cputhreshold", + "description": "the total cpu allocated in GiB", + "name": "memoryallocated", + "type": "string" + }, + { + "description": "the dhcp Provider for the Zone", + "name": "dhcpprovider", + "type": "string" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "true if security groups support is enabled, false otherwise", + "name": "securitygroupsenabled", "type": "boolean" }, { - "description": "the first IPv6 DNS for the Zone", - "name": "ip6dns1", + "description": "the second internal DNS for the Zone", + "name": "internaldns2", "type": "string" }, { @@ -155700,131 +156437,171 @@ "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": "Zone name", + "name": "name", + "type": "string" + }, + { + "description": "the second DNS for the Zone", + "name": "dns2", + "type": "string" + }, + { + "description": "the second IPv6 DNS for the Zone", + "name": "ip6dns2", + "type": "string" + }, + { + "description": "the type of the zone - core or edge", + "name": "type", "type": "string" }, + { + "description": "The maximum value the MTU can have on the VR's private interfaces", + "name": "routerprivateinterfacemaxmtu", + "type": "integer" + }, { "description": "true if the entity/resource has annotations", "name": "hasannotations", "type": "boolean" }, { - "description": "The maximum value the MTU can have on the VR's private interfaces", - "name": "routerprivateinterfacemaxmtu", + "description": "true, if routed network/vpc is enabled", + "name": "routedmodeenabled", + "type": "boolean" + }, + { + "description": "The maximum value the MTU can have on the VR's public interfaces", + "name": "routerpublicinterfacemaxmtu", "type": "integer" }, { - "description": "the allocation state of the cluster", - "name": "allocationstate", + "description": "the total cpu allocated in Ghz", + "name": "cpuallocated", "type": "string" }, { - "description": "the total cpu capacity in GiB", - "name": "memorytotal", + "description": "cpu allocated disable threshold exceeded", + "name": "cpuallocateddisablethreshold", + "type": "boolean" + }, + { + "description": "the maximum memory deviation", + "name": "memorymaxdeviation", "type": "string" }, { - "description": "the display text of the zone", - "name": "displaytext", + "description": "Network domain name for the networks in the zone", + "name": "domain", + "type": "string" + }, + { + "description": "healthy / total clusters in the zone", + "name": "clusters", "type": "string" }, {}, { - "description": "the type of the zone - core or edge", - "name": "type", + "description": "Zone id", + "name": "id", "type": "string" }, { - "description": "the UUID of the containing domain, null for public zones", - "name": "domainid", + "description": "the maximum cpu deviation", + "name": "cpumaxdeviation", "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": "Zone name", - "name": "name", - "type": "string" + "description": "cpu allocated notification threshold exceeded", + "name": "cpuallocatedthreshold", + "type": "boolean" }, { - "description": "Zone Token", - "name": "zonetoken", - "type": "string" + "description": "true, if zone is NSX enabled", + "name": "isnsxenabled", + "type": "boolean" + }, + { + "description": "cpu usage notification threshold exceeded", + "name": "cputhreshold", + "type": "boolean" }, { "description": "the list of resource tags associated with zone.", "name": "tags", "response": [ { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the 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": "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 project name where tag belongs to", - "name": "project", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "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": "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" } ], "type": "set" }, { - "description": "true, if zone is NSX enabled", - "name": "isnsxenabled", + "description": "true, if zone contains clusters and hosts from different CPU architectures", + "name": "ismultiarch", "type": "boolean" }, { @@ -155833,63 +156610,58 @@ "type": "long" }, { - "description": "the name of the containing domain, null for public zones", - "name": "domainname", - "type": "string" + "description": "true if local storage offering enabled, false otherwise", + "name": "localstorageenabled", + "type": "boolean" }, { - "description": "the network type of the zone; can be Basic or Advanced", - "name": "networktype", - "type": "string" + "description": "memory allocated disable threshold exceeded", + "name": "memoryallocateddisablethreshold", + "type": "boolean" }, { - "description": "the total cpu capacity in Ghz", - "name": "cputotal", + "description": "Zone Token", + "name": "zonetoken", "type": "string" }, { - "description": "true if security groups support is enabled, false otherwise", - "name": "securitygroupsenabled", - "type": "boolean" + "description": "the name of the containing domain, null for public zones", + "name": "domainname", + "type": "string" }, { - "description": "cpu allocated disable threshold exceeded", - "name": "cpuallocateddisablethreshold", - "type": "boolean" + "description": "the total cpu used in Ghz", + "name": "cpuused", + "type": "string" }, { - "description": "the dhcp Provider for the Zone", - "name": "dhcpprovider", + "description": "External network provider if any", + "name": "provider", "type": "string" }, { - "description": "memory usage notification threshold exceeded", - "name": "memorythreshold", + "description": "memory usage disable threshold exceeded", + "name": "memorydisablethreshold", "type": "boolean" }, { - "description": "the total cpu allocated in Ghz", - "name": "cpuallocated", - "type": "string" - }, - { - "description": "the second IPv6 DNS for the Zone", - "name": "ip6dns2", + "description": "the first DNS for the Zone", + "name": "dns1", "type": "string" }, { - "description": "healthy / total clusters in the zone", - "name": "clusters", - "type": "string" + "description": "memory allocated notification threshold exceeded", + "name": "memoryallocatedthreshold", + "type": "boolean" }, { - "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 second DNS for the Zone", - "name": "dns2", + "description": "the first IPv6 DNS for the Zone", + "name": "ip6dns1", "type": "string" }, { @@ -155897,19 +156669,19 @@ "name": "capacity", "response": [ { - "description": "the Pod ID", - "name": "podid", - "type": "string" + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" }, { - "description": "the Cluster name", - "name": "clustername", + "description": "The tag for the capacity type", + "name": "tag", "type": "string" }, { - "description": "the capacity name", - "name": "name", - "type": "string" + "description": "the capacity type", + "name": "type", + "type": "short" }, { "description": "the Zone ID", @@ -155917,33 +156689,23 @@ "type": "string" }, { - "description": "the percentage of capacity currently in use", - "name": "percentused", + "description": "the Pod ID", + "name": "podid", "type": "string" }, { - "description": "the Zone name", - "name": "zonename", + "description": "the Cluster name", + "name": "clustername", "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 Pod name", - "name": "podname", + "description": "the capacity name", + "name": "name", "type": "string" }, { @@ -155951,114 +156713,28 @@ "name": "clusterid", "type": "string" }, + { + "description": "the Zone name", + "name": "zonename", + "type": "string" + }, { "description": "the capacity currently in allocated", "name": "capacityallocated", "type": "long" }, { - "description": "The tag for the capacity type", - "name": "tag", + "description": "the Pod name", + "name": "podname", + "type": "string" + }, + { + "description": "the percentage of capacity currently in use", + "name": "percentused", "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" - }, - {}, - { - "description": "memory allocated notification threshold exceeded", - "name": "memoryallocatedthreshold", - "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", - "type": "string" - }, - { - "description": "Total GPUs in the Zone", - "name": "gputotal", - "type": "long" - }, - { - "description": "true if local storage offering enabled, false otherwise", - "name": "localstorageenabled", - "type": "boolean" - }, - { - "description": "memory usage disable threshold exceeded", - "name": "memorydisablethreshold", - "type": "boolean" - }, - { - "description": "the total cpu used in Ghz", - "name": "cpuused", - "type": "string" - }, - { - "description": "Meta data associated with the zone (key/value pairs)", - "name": "resourcedetails", - "type": "map" } ], "since": "4.9.3" @@ -156069,11 +156745,11 @@ "name": "extractTemplate", "params": [ { - "description": "the ID of the zone where the ISO is originally located", + "description": "the ID of the template", "length": 255, - "name": "zoneid", - "related": "listZones", - "required": false, + "name": "id", + "related": "registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "required": true, "type": "uuid" }, { @@ -156084,11 +156760,11 @@ "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" }, { @@ -156102,85 +156778,85 @@ "related": "extractSnapshot", "response": [ { - "description": "the upload id of extracted object", - "name": "extractId", + "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": "zone ID the object was extracted from", + "name": "zoneid", + "type": "string" }, { - "description": "the mode of extraction - upload or download", - "name": "extractMode", + "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 status of the extraction", + "name": "status", + "type": "string" }, { - "description": "the account id to which the extracted object belongs", - "name": "accountid", - "type": "string" + "description": "the time and date the object was created", + "name": "created", + "type": "date" }, + {}, { - "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": "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": "", + "name": "resultstring", "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 account id to which the extracted object belongs", + "name": "accountid", "type": "string" }, - {}, { - "description": "the percentage of the entity uploaded to the specified location", - "name": "uploadpercentage", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, + {}, { "description": "the id of extracted object", "name": "id", "type": "string" }, { - "description": "type of the storage", - "name": "storagetype", + "description": "the mode of extraction - upload or download", + "name": "extractMode", "type": "string" }, { - "description": "", - "name": "resultstring", - "type": "string" + "description": "the percentage of the entity uploaded to the specified location", + "name": "uploadpercentage", + "type": "integer" }, { - "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 state of the extracted object", - "name": "state", + "description": "zone name the object was extracted from", + "name": "zonename", "type": "string" }, { - "description": "zone name the object was extracted from", - "name": "zonename", + "description": "type of the storage", + "name": "storagetype", "type": "string" } ] @@ -156194,33 +156870,33 @@ "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,createVMFromBackup,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "required": true, "type": "uuid" } ], "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": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -156229,14 +156905,6 @@ "isasync": true, "name": "updateIpAddress", "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": "the ID of the public IP address to update", "length": 255, @@ -156245,6 +156913,14 @@ "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" + }, { "description": "an optional field, whether to the display the IP to the end user or not", "length": 255, @@ -156257,14 +156933,14 @@ "related": "associateIpAddress,listPublicIpAddresses", "response": [ { - "description": "the domain the public IP address is associated with", - "name": "domain", + "description": "VPC id the ip belongs to", + "name": "vpcid", "type": "string" }, { - "description": "true if range is dedicated for external network providers", - "name": "forprovider", - "type": "boolean" + "description": "the name of the zone the public IP address belongs to", + "name": "zonename", + "type": "string" }, { "description": "the virtual network for the IP address", @@ -156277,79 +156953,62 @@ "type": "string" }, { - "description": "State of the ip address. Can be: Allocating, Allocated, Releasing, Reserved and Free", - "name": "state", - "type": "string" - }, - {}, - { - "description": "virtual machine name the ip address is assigned to", - "name": "virtualmachinename", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "virtual machine id the ip address is assigned to", + "name": "virtualmachineid", "type": "string" }, { - "description": "VPC name the ip belongs to", - "name": "vpcname", - "type": "string" + "description": "is public IP portable across the zones", + "name": "isportable", + "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": "is public ip for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the ID of the Network associated with the IP address", - "name": "associatednetworkid", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "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": "the ID of the VLAN associated with the IP address. This parameter is visible to ROOT admins only", - "name": "vlanid", + "description": "public IP address", + "name": "ipaddress", "type": "string" }, - { - "description": "true if this ip is for static nat, false otherwise", - "name": "isstaticnat", - "type": "boolean" - }, { "description": "the list of resource tags associated with ip address", "name": "tags", "response": [ { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "tag value", - "name": "value", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the account associated with the tag", + "name": "account", "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": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -156368,46 +157027,56 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag value", + "name": "value", "type": "string" } ], "type": "list" }, { - "description": "the account the public IP address is associated with", - "name": "account", + "description": "State of the ip address. Can be: Allocating, Allocated, Releasing, Reserved and Free", + "name": "state", "type": "string" }, { - "description": "path of the domain to which the public IP address belongs", - "name": "domainpath", - "type": "string" + "description": "true if range is dedicated for external network providers", + "name": "forprovider", + "type": "boolean" }, { - "description": "true if the IP address is a source nat address, false otherwise", - "name": "issourcenat", + "description": "true if this ip is system ip (was allocated as a part of deployVm or createLbRule)", + "name": "issystem", "type": "boolean" }, { - "description": "the ID of the zone the public IP address belongs to", - "name": "zoneid", + "description": "virtual machine (dnat) ip address (not null only for static nat Ip)", + "name": "vmipaddress", "type": "string" }, { - "description": "VPC id the ip belongs to", - "name": "vpcid", + "description": "the VLAN associated with the IP address", + "name": "vlanname", + "type": "string" + }, + { + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { @@ -156415,34 +157084,30 @@ "name": "jobstatus", "type": "integer" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "is public IP portable across the zones", - "name": "isportable", - "type": "boolean" - }, - { - "description": "the ID of the Network where ip belongs to", - "name": "networkid", + "description": "the ID of the Network associated with the IP address", + "name": "associatednetworkid", "type": "string" }, { - "description": "date the public IP address was acquired", - "name": "allocated", - "type": "date" + "description": "true if range is dedicated for System VMs", + "name": "forsystemvms", + "type": "boolean" }, { - "description": "is public ip for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the ID of the zone the public IP address belongs to", + "name": "zoneid", + "type": "string" }, { - "description": "the domain ID the public IP address is associated with", - "name": "domainid", + "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" }, { @@ -156451,68 +157116,79 @@ "type": "boolean" }, { - "description": "virtual machine (dnat) ip address (not null only for static nat Ip)", - "name": "vmipaddress", - "type": "string" + "description": "date the public IP address was acquired", + "name": "allocated", + "type": "date" }, { - "description": "true if range is dedicated for System VMs", - "name": "forsystemvms", - "type": "boolean" + "description": "the ID of the Network where ip belongs to", + "name": "networkid", + "type": "string" }, { - "description": "public IP address", - "name": "ipaddress", + "description": "virtual machine display name the ip address is assigned to (not null only for static nat Ip)", + "name": "virtualmachinedisplayname", "type": "string" }, { - "description": "the VLAN associated with the IP address", - "name": "vlanname", + "description": "VPC name the ip belongs to", + "name": "vpcname", "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": "true if the IP address is a source nat address, false otherwise", + "name": "issourcenat", + "type": "boolean" + }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the name of the Network associated with the IP address", - "name": "associatednetworkname", + "description": "virtual machine name the ip address is assigned to", + "name": "virtualmachinename", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if this ip is for static nat, false otherwise", + "name": "isstaticnat", "type": "boolean" }, + {}, { - "description": "true if this ip is system ip (was allocated as a part of deployVm or createLbRule)", - "name": "issystem", - "type": "boolean" + "description": "the account the public IP address is associated with", + "name": "account", + "type": "string" }, { - "description": "the name of the Network where ip belongs to", - "name": "networkname", + "description": "the domain ID the public IP address is associated with", + "name": "domainid", "type": "string" }, { - "description": "the name of the zone the public IP address belongs to", - "name": "zonename", + "description": "the domain the public IP address is associated with", + "name": "domain", "type": "string" }, { - "description": "virtual machine id the ip address is assigned to", - "name": "virtualmachineid", + "description": "the name of the Network where ip belongs to", + "name": "networkname", "type": "string" }, { - "description": "virtual machine type the ip address is assigned to", - "name": "virtualmachinetype", + "description": "the name of the Network associated with the IP address", + "name": "associatednetworkname", "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "path of the domain to which the public IP address belongs", + "name": "domainpath", + "type": "string" + }, + { + "description": "the ID of the VLAN associated with the IP address. This parameter is visible to ROOT admins only", + "name": "vlanid", "type": "string" } ] @@ -156523,11 +157199,12 @@ "name": "migrateNetwork", "params": [ { - "description": "true if previous network migration cmd failed", + "description": "network offering ID", "length": 255, - "name": "resume", - "required": false, - "type": "boolean" + "name": "networkofferingid", + "related": "", + "required": true, + "type": "uuid" }, { "description": "the ID of the network", @@ -156538,49 +157215,60 @@ "type": "uuid" }, { - "description": "network offering ID", + "description": "true if previous network migration cmd failed", "length": 255, - "name": "networkofferingid", - "related": "", - "required": true, - "type": "uuid" + "name": "resume", + "required": false, + "type": "boolean" } ], "related": "createNetwork,updateNetwork,listNetworks", "response": [ { - "description": "The Ipv6 routing type of network offering", - "name": "ip6routing", - "type": "string" + "description": "true if users from subdomains can access the domain level network", + "name": "subdomainaccess", + "type": "boolean" }, { - "description": "the name of the network", - "name": "name", + "description": "acl type - access type to the network", + "name": "acltype", "type": "string" }, { - "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", - "name": "broadcasturi", + "description": "The IPv4 routing type of network", + "name": "ip4routing", "type": "string" }, { - "description": "The IPv4 routing type of network", - "name": "ip4routing", + "description": "If the network has redundant routers enabled", + "name": "redundantrouter", + "type": "boolean" + }, + { + "description": "the network's netmask", + "name": "netmask", "type": "string" }, + {}, { - "description": "ACL Id associated with the VPC network", - "name": "aclid", + "description": "The external id of the network", + "name": "externalid", "type": "string" }, { - "description": "path of the Domain the network belongs to", - "name": "domainpath", + "description": "true if network supports specifying ip ranges, false otherwise", + "name": "specifyipranges", + "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": "VPC the network belongs to", - "name": "vpcid", + "description": "the name of the zone the network belongs to", + "name": "zonename", "type": "string" }, { @@ -156589,29 +157277,157 @@ "type": "string" }, { - "description": "the second IPv6 DNS for the network", - "name": "ip6dns2", - "type": "string" + "description": "the list of resource tags associated with network", + "name": "tags", + "response": [ + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "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": "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 key name", + "name": "key", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + } + ], + "type": "list" }, { - "description": "the first IPv6 DNS for the network", - "name": "ip6dns1", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "Broadcast domain type of the network", + "name": "broadcastdomaintype", + "type": "string" }, { - "description": "The vlan of the network. This parameter is visible to ROOT admins only", - "name": "vlan", + "description": "the physical network id", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the date this network was created", - "name": "created", - "type": "date" + "description": "the list of 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": "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": "state of the network provider", + "name": "state", + "type": "string" + }, + { + "description": "the provider name", + "name": "name", + "type": "string" + }, + { + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the service name", + "name": "name", + "type": "string" + }, + { + "description": "the list of capabilities", + "name": "capability", + "response": [ + { + "description": "the capability value", + "name": "value", + "type": "string" + }, + { + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" + }, + { + "description": "the capability name", + "name": "name", + "type": "string" + } + ], + "type": "list" + } + ], + "type": "list" }, { "description": "the name of the Network associated with this private gateway", @@ -156619,73 +157435,63 @@ "type": "string" }, { - "description": "the displaytext of the network", - "name": "displaytext", - "type": "string" - }, - { - "description": "the owner of the network", - "name": "account", + "description": "Tungsten-Fabric virtual router the network belongs to", + "name": "tungstenvirtualrouteruuid", "type": "string" }, { - "description": "true if network is default, false otherwise", - "name": "isdefault", + "description": "list networks available for vm deployment", + "name": "canusefordeploy", "type": "boolean" }, { - "description": "the domain name of the network owner", - "name": "domain", - "type": "string" - }, - { - "description": "zone id of the network", - "name": "zoneid", + "description": "name of the network offering the network is created from", + "name": "networkofferingname", "type": "string" }, { - "description": "the physical network id", - "name": "physicalnetworkid", - "type": "string" + "description": "list networks that are persistent", + "name": "ispersistent", + "type": "boolean" }, { - "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": "list networks available for vm deployment", - "name": "canusefordeploy", - "type": "boolean" + "description": "the name of the network", + "name": "name", + "type": "string" }, { - "description": "the network's gateway", - "name": "gateway", + "description": "the owner of the network", + "name": "account", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "display text of the network offering the network is created from", + "name": "networkofferingdisplaytext", "type": "string" }, { - "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 displaytext of the network", + "name": "displaytext", "type": "string" }, { - "description": "the domain id of the network owner", - "name": "domainid", + "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", + "name": "broadcasturi", "type": "string" }, { - "description": "the first IPv4 DNS for the network", - "name": "dns1", + "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", + "name": "cidr", "type": "string" }, { @@ -156694,59 +157500,59 @@ "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" }, { - "description": "acl type - access type to the network", - "name": "acltype", - "type": "string" + "description": "true if network can span multiple zones", + "name": "strechedl2subnet", + "type": "boolean" }, { - "description": "If the network has redundant routers enabled", - "name": "redundantrouter", + "description": "true if network is system, false otherwise", + "name": "issystem", "type": "boolean" }, { - "description": "the network's netmask", - "name": "netmask", - "type": "string" + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" }, { - "description": "Broadcast domain type of the network", - "name": "broadcastdomaintype", + "description": "the first IPv4 DNS for the network", + "name": "dns1", "type": "string" }, { - "description": "The external id of the network", - "name": "externalid", + "description": "ACL name associated with the VPC network", + "name": "aclname", "type": "string" }, { - "description": "true if network supports specifying ip ranges, false otherwise", - "name": "specifyipranges", - "type": "boolean" + "description": "The BGP peers for the network", + "name": "bgppeers", + "type": "set" }, { - "description": "true if guest network default egress policy is allow; false if default egress policy is deny", - "name": "egressdefaultpolicy", + "description": "an optional field, whether to the display the network to the end user or not.", + "name": "displaynetwork", "type": "boolean" }, { - "description": "if network offering supports vm autoscaling feature", - "name": "supportsvmautoscaling", - "type": "boolean" + "description": "the date this network was created", + "name": "created", + "type": "date" }, { - "description": "MTU configured on the network VR's private interfaces", - "name": "privatemtu", - "type": "integer" + "description": "UUID of AS NUMBER", + "name": "asnumberid", + "type": "string" }, { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip6routes", - "type": "set" + "description": "path of the Domain the network belongs to", + "name": "domainpath", + "type": "string" }, { "description": "the details of the network", @@ -156754,58 +157560,58 @@ "type": "map" }, { - "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": "true if network can span multiple zones", - "name": "strechedl2subnet", - "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": "zone id of the network", + "name": "zoneid", "type": "string" }, { - "description": "Tungsten-Fabric virtual router the network belongs to", - "name": "tungstenvirtualrouteruuid", - "type": "string" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE", - "name": "networkcidr", - "type": "string" + "description": "true if guest network default egress policy is allow; false if default egress policy is deny", + "name": "egressdefaultpolicy", + "type": "boolean" }, { - "description": "the name of the zone the network belongs to", - "name": "zonename", + "description": "The internet protocol of network offering", + "name": "internetprotocol", "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": "MTU configured on the network VR's public facing interfaces", + "name": "publicmtu", + "type": "integer" }, { - "description": "true if network is system, false otherwise", - "name": "issystem", - "type": "boolean" + "description": "the type of the network", + "name": "type", + "type": "string" }, { - "description": "the traffic type of the network", - "name": "traffictype", + "description": "the first IPv6 DNS for the network", + "name": "ip6dns1", "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": "state of the network", + "name": "state", + "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" }, { @@ -156814,264 +157620,134 @@ "type": "set" }, { - "description": "UUID of AS NUMBER", - "name": "asnumberid", - "type": "string" - }, - { - "description": "the list of services", - "name": "service", - "response": [ - { - "description": "the service provider name", - "name": "provider", - "response": [ - { - "description": "the provider name", - "name": "name", - "type": "string" - }, - { - "description": "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 service name", - "name": "name", - "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" - } - ], - "type": "list" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "true if network offering is ip conserve mode enabled", "name": "networkofferingconservemode", "type": "boolean" }, - { - "description": "the second IPv4 DNS for the network", - "name": "dns2", - "type": "string" - }, { "description": "the id of the network", "name": "id", "type": "string" }, { - "description": "availability of the network offering the network is created from", - "name": "networkofferingavailability", + "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": "true if users from subdomains can access the domain level network", - "name": "subdomainaccess", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "The internet protocol of network offering", - "name": "internetprotocol", + "description": "the traffic type of the network", + "name": "traffictype", "type": "string" }, { - "description": "network offering id the network is created from", - "name": "networkofferingid", + "description": "VPC the network belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the project name of the address", - "name": "project", - "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 BGP peers for the network", - "name": "bgppeers", - "type": "set" + "description": "true if network supports specifying vlan, false otherwise", + "name": "specifyvlan", + "type": "boolean" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the network's gateway", + "name": "gateway", "type": "string" }, { - "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", - "name": "cidr", + "description": "the domain name of the network owner", + "name": "domain", "type": "string" }, { - "description": "MTU configured on the network VR's public facing interfaces", - "name": "publicmtu", - "type": "integer" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "availability of the network offering the network is created from", + "name": "networkofferingavailability", + "type": "string" + }, + { + "description": "AS NUMBER", + "name": "asnumber", + "type": "long" }, { - "description": "an optional field, whether to the display the network to the end user or not.", - "name": "displaynetwork", - "type": "boolean" + "description": "the second IPv6 DNS for the network", + "name": "ip6dns2", + "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 network requires restart", "name": "restartrequired", "type": "boolean" }, - {}, { - "description": "state of the network", - "name": "state", - "type": "string" + "description": "if network offering supports vm autoscaling feature", + "name": "supportsvmautoscaling", + "type": "boolean" }, { - "description": "the ID of the Network associated with this private gateway", - "name": "associatednetworkid", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "ACL name associated with the VPC network", - "name": "aclname", + "description": "ACL Id associated with the VPC network", + "name": "aclid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the second IPv4 DNS for the network", + "name": "dns2", "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": "AS NUMBER", - "name": "asnumber", - "type": "long" + "description": "The Ipv6 routing type of network offering", + "name": "ip6routing", + "type": "string" }, { - "description": "the list of resource tags associated with network", - "name": "tags", - "response": [ - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - } - ], - "type": "list" + "description": "Name of the VPC to which this network belongs", + "name": "vpcname", + "type": "string" }, { - "description": "list networks that are persistent", - "name": "ispersistent", - "type": "boolean" + "description": "The vlan of the network. This parameter is visible to ROOT admins only", + "name": "vlan", + "type": "string" } ], "since": "4.11.0" @@ -157081,6 +157757,13 @@ "isasync": false, "name": "listUnmanagedInstances", "params": [ + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, { "description": "the hypervisor name of the instance", "length": 255, @@ -157089,11 +157772,11 @@ "type": "string" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { "description": "the cluster ID", @@ -157109,122 +157792,72 @@ "name": "pagesize", "required": false, "type": "integer" - }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "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", - "type": "integer" - }, - { - "description": "indicates the boot mode", - "name": "bootmode", + "description": "indicates the boot type", + "name": "boottype", "type": "string" }, { - "description": "the list of disks associated with the virtual machine", - "name": "disk", + "description": "the list of nics associated with the virtual machine", + "name": "nic", "response": [ { - "description": "the capacity of the disk in bytes", - "name": "capacity", - "type": "long" - }, - { - "description": "the controller of the disk", - "name": "controller", - "type": "string" - }, - { - "description": "the position of the disk", - "name": "position", - "type": "integer" - }, - { - "description": "the controller of the disk", - "name": "datastorepath", - "type": "string" - }, - { - "description": "the controller unit of the disk", - "name": "controllerunit", - "type": "integer" - }, - { - "description": "the controller of the disk", - "name": "datastorehost", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "the ID of the disk", - "name": "id", + "description": "the ip address of the nic", + "name": "ipaddress", "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 label of the disk", - "name": "label", - "type": "string" + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" }, { - "description": "the controller of the disk", - "name": "datastoretype", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the controller of the disk", - "name": "datastorename", - "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 broadcast uri of the nic", + "name": "broadcasturi", "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" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { @@ -157233,29 +157866,34 @@ "type": "list" }, { - "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": "the IPv6 address of network", - "name": "ip6address", + "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", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" }, { "description": "true if nic is default, false otherwise", @@ -157263,58 +157901,53 @@ "type": "boolean" }, { - "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 gateway of IPv6 network", - "name": "ip6gateway", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { @@ -157323,56 +157956,21 @@ "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", + "description": "the netmask of the nic", + "name": "netmask", "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 Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "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 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", + "description": "the power state of the virtual machine", + "name": "powerstate", "type": "string" }, { @@ -157381,50 +157979,128 @@ "type": "integer" }, { - "description": "indicates the boot type", - "name": "boottype", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the power state of the virtual machine", - "name": "powerstate", + "description": "the operating system ID of the virtual machine", + "name": "osid", "type": "string" }, { - "description": "the name of the host to which virtual machine belongs", - "name": "hostname", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, + { + "description": "the CPU cores per socket for the virtual machine. VMware specific", + "name": "cpucorepersocket", + "type": "integer" + }, { "description": "the CPU speed of the virtual machine", "name": "cpuspeed", "type": "integer" }, { - "description": "the operating system ID of the virtual machine", - "name": "osid", - "type": "string" + "description": "the memory of the virtual machine in MB", + "name": "memory", + "type": "integer" }, - {}, { - "description": "the ID of the cluster to which virtual machine belongs", - "name": "clusterid", + "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 list of disks associated with the virtual machine", + "name": "disk", + "response": [ + { + "description": "the controller of the disk", + "name": "datastorepath", + "type": "string" + }, + { + "description": "the capacity of the disk in bytes", + "name": "capacity", + "type": "long" + }, + { + "description": "the position of the disk", + "name": "position", + "type": "integer" + }, + { + "description": "the label of the disk", + "name": "label", + "type": "string" + }, + { + "description": "the controller of the disk", + "name": "controller", + "type": "string" + }, + { + "description": "the controller of the disk", + "name": "datastorehost", + "type": "string" + }, + { + "description": "the file path of the disk image", + "name": "imagepath", + "type": "string" + }, + { + "description": "the controller of the disk", + "name": "datastorename", + "type": "string" + }, + { + "description": "the ID of the disk", + "name": "id", + "type": "string" + }, + { + "description": "the controller unit of the disk", + "name": "controllerunit", + "type": "integer" + }, + { + "description": "the controller of the disk", + "name": "datastoretype", + "type": "string" + } + ], + "type": "set" + }, { "description": "the ID of the host to which virtual machine belongs", "name": "hostid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "indicates the boot mode", + "name": "bootmode", + "type": "string" + }, + { + "description": "the ID of the cluster to which virtual machine belongs", + "name": "clusterid", + "type": "string" + }, + { + "description": "the name of the host to which virtual machine belongs", + "name": "hostname", + "type": "string" } ], "since": "4.14.0" @@ -157435,42 +158111,33 @@ "name": "registerTemplate", "params": [ { - "description": "true if template should bypass Secondary Storage and be downloaded to Primary Storage on deployment", + "description": "true if the template supports the password reset feature; default is false", "length": 255, - "name": "directdownload", + "name": "passwordenabled", "required": false, "type": "boolean" }, { - "description": "the CPU arch of the template. Valid options are: x86_64, aarch64", - "length": 255, - "name": "arch", - "required": false, - "since": "4.20", - "type": "string" - }, - { - "description": "true if the template supports the password reset feature; default is false", + "description": "Register template for the project", "length": 255, - "name": "passwordenabled", + "name": "projectid", + "related": "", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "A list of zone ids where the template will be hosted. Use this parameter if the template needs to be registered to multiple zones in one go. Use zoneid if the template needs to be registered to only one zone.Passing only -1 to this will cause the template to be registered as a cross zone template and will be copied to all zones. ", + "description": "an optional accountName. Must be used with domainId.", "length": 255, - "name": "zoneids", - "related": "listZones", + "name": "account", "required": false, - "type": "list" + "type": "string" }, { - "description": "an optional domainId. If the account parameter is used, domainId must also be used.", + "description": "true if the template supports the sshkey upload feature; default is false", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "sshkeyenabled", "required": false, - "type": "uuid" + "type": "boolean" }, { "description": "(VMware only) true if VM deployments should preserve all the configurations defined for this template", @@ -157481,25 +158148,27 @@ "type": "boolean" }, { - "description": "true if this template is a featured template, false otherwise", + "description": "true if template should bypass Secondary Storage and be downloaded to Primary Storage on deployment", "length": 255, - "name": "isfeatured", + "name": "directdownload", "required": false, "type": "boolean" }, { - "description": "Template 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" + "since": "4.19.0", + "type": "string" }, { - "description": "true if the template type is routing i.e., if template is used to deploy router", + "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": "isrouting", + "name": "ostypeid", + "related": "", "required": false, - "type": "boolean" + "type": "uuid" }, { "description": "ID of the extension", @@ -157511,84 +158180,89 @@ "type": "uuid" }, { - "description": "the target hypervisor for the template", + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", "length": 255, - "name": "hypervisor", - "required": true, - "type": "string" + "name": "isdynamicallyscalable", + "required": false, + "type": "boolean" }, { - "description": "Register template for the project", + "description": "32 or 64 bits support. 64 by default", "length": 255, - "name": "projectid", - "related": "", + "name": "bits", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "true if this template requires HVM", - "length": 255, - "name": "requireshvm", + "description": "The display text of the template, defaults to 'name'.", + "length": 4096, + "name": "displaytext", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "the format for the template. Possible values include QCOW2, RAW, VHD and OVA.", - "length": 255, - "name": "format", + "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 type of the template. Valid options are: USER/VNF (for all users) and SYSTEM/ROUTING/BUILTIN (for admins only).", + "description": "true if the template is available to all accounts; default is true", "length": 255, - "name": "templatetype", + "name": "ispublic", "required": false, - "since": "4.19.0", + "type": "boolean" + }, + { + "description": "the name of the template", + "length": 255, + "name": "name", + "required": true, "type": "string" }, { - "description": "32 or 64 bits support. 64 by default", + "description": "the target hypervisor for the template", "length": 255, - "name": "bits", - "required": false, - "type": "integer" + "name": "hypervisor", + "required": true, + "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": "Details in key/value pairs using format externaldetails[i].keyname=keyvalue. Example: externaldetails[0].endpoint.url=urlvalue", "length": 255, - "name": "ostypeid", - "related": "", + "name": "externaldetails", "required": false, - "type": "uuid" + "since": "4.21.0", + "type": "map" }, { - "description": "the URL of where the template is hosted. Possible URL include http:// and https://", - "length": 2048, - "name": "url", + "description": "the format for the template. Possible values include QCOW2, RAW, VHD and OVA.", + "length": 255, + "name": "format", "required": true, "type": "string" }, { - "description": "the name of the template", + "description": "true if the template type is routing i.e., if template is used to deploy router", "length": 255, - "name": "name", - "required": true, - "type": "string" + "name": "isrouting", + "required": false, + "type": "boolean" }, { - "description": "true if the template or its derivatives are extractable; default is false", + "description": "Template details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", "length": 255, - "name": "isextractable", + "name": "details", "required": false, - "type": "boolean" + "type": "map" }, { - "description": "true if the template supports the sshkey upload feature; default is false", + "description": "the tag for this template.", "length": 255, - "name": "sshkeyenabled", + "name": "templatetag", "required": false, - "type": "boolean" + "type": "string" }, { "description": "the ID of the zone the template is to be hosted on", @@ -157599,16 +158273,16 @@ "type": "uuid" }, { - "description": "true if the template is available to all accounts; default is true", + "description": "true if this template requires HVM", "length": 255, - "name": "ispublic", + "name": "requireshvm", "required": false, "type": "boolean" }, { - "description": "The display text of the template, defaults to 'name'.", - "length": 4096, - "name": "displaytext", + "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": "checksum", "required": false, "type": "string" }, @@ -157621,177 +158295,170 @@ "type": "boolean" }, { - "description": "an optional accountName. Must be used with domainId.", + "description": "an optional domainId. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "account", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "Details in key/value pairs using format externaldetails[i].keyname=keyvalue. Example: externaldetails[0].endpoint.url=urlvalue", + "description": "the CPU arch of the template. Valid options are: x86_64, aarch64", "length": 255, - "name": "externaldetails", + "name": "arch", "required": false, - "since": "4.21.0", - "type": "map" + "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 or its derivatives are extractable; default is false", "length": 255, - "name": "isdynamicallyscalable", + "name": "isextractable", "required": false, "type": "boolean" }, { - "description": "the checksum value of this template. The parameter containing the checksum will be considered a MD5sum if it is not prefixed\n and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to\n use another algorithm the hexadecimal string is to be prefixed with a string of the form,\n \"{}\", not including the double quotes. In this is the exact string\n representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not\n contain an algorithm called SHA256 or one called sha-256, only SHA-256.", + "description": "true if this template is a featured template, false otherwise", "length": 255, - "name": "checksum", + "name": "isfeatured", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "the tag for this template.", + "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": "templatetag", + "name": "zoneids", + "related": "listZones", "required": false, - "type": "string" + "type": "list" } ], - "related": "listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "related": "registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", "response": [ { - "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 account name to which the template belongs", - "name": "account", + "description": "CPU Arch of the template", + "name": "arch", "type": "string" }, { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", "type": "boolean" }, { - "description": "The ID of extension linked to this template", - "name": "extensionid", + "description": "path of the Domain the template belongs to", + "name": "domainpath", "type": "string" }, + {}, { - "description": "checksum of the template", - "name": "checksum", + "description": "the name of the secondary storage host for the template", + "name": "hostname", "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 tag of this template", + "name": "templatetag", "type": "string" }, { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", + "description": "If true it indicates that the template can be used for CKS cluster deployments", + "name": "forcks", "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "The name of extension linked to this template", - "name": "extensionname", - "type": "string" - }, - { - "description": "the template name", - "name": "name", + "description": "the id of userdata linked to this template", + "name": "userdataid", "type": "string" }, { - "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" }, { - "description": "the date this template was created", - "name": "created", - "type": "date" + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", + "description": "the account name to which the template belongs", + "name": "account", "type": "string" }, { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" + "description": "checksum of the template", + "name": "checksum", + "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 this template is a public template, false otherwise", - "name": "ispublic", - "type": "boolean" + "description": "the template display text", + "name": "displaytext", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the format of the template.", + "name": "format", + "type": "imageformat" }, { - "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 reset password feature is enabled, false otherwise", + "name": "passwordenabled", "type": "boolean" }, { - "description": "the template ID", - "name": "id", + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", "type": "string" }, { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" + "description": "the type of the template", + "name": "templatetype", + "type": "string" }, { - "description": "the name of the secondary storage host for the template", - "name": "hostname", + "description": "the name of userdata linked to this template", + "name": "userdataname", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" }, { "description": "the list of resource tags associated", "name": "tags", "response": [ + { + "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", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -157800,13 +158467,8 @@ "type": "string" }, { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -157815,87 +158477,67 @@ "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": "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": "tag key name", - "name": "key", + "description": "resource type", + "name": "resourcetype", "type": "string" } ], "type": "set" }, { - "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": "the template display text", - "name": "displaytext", - "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 tag of this template", - "name": "templatetag", - "type": "string" + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the OS type for this template.", + "name": "ostypeid", "type": "string" }, - { - "description": "the size of the template", - "name": "size", - "type": "long" - }, { "description": "true if the template is ready to be deployed from, false otherwise.", "name": "isready", "type": "boolean" }, { - "description": "CPU Arch of the template", - "name": "arch", - "type": "string" + "description": "the physical size of the template", + "name": "physicalsize", + "type": "long" }, { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", "type": "boolean" }, { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", + "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": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { "description": "true if the ISO is bootable, false otherwise", @@ -157903,8 +158545,13 @@ "type": "boolean" }, { - "description": "the type of the template", - "name": "templatetype", + "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 secondary storage host for the template", + "name": "hostid", "type": "string" }, { @@ -157913,23 +158560,23 @@ "type": "string" }, { - "description": "the physical size of the template", - "name": "physicalsize", - "type": "long" + "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 date this template was created", + "name": "created", + "type": "date" }, { - "description": "the name of the zone for this template", - "name": "zonename", - "type": "string" + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { @@ -157937,9 +158584,25 @@ "name": "ostypename", "type": "string" }, + {}, { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", + "description": "the name of the domain to which the template belongs", + "name": "domain", + "type": "string" + }, + { + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", + "type": "boolean" + }, + { + "description": "the template name", + "name": "name", + "type": "string" + }, + { + "description": "the project id of the template", + "name": "projectid", "type": "string" }, { @@ -157948,71 +158611,84 @@ "type": "int" }, { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "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 UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "If true it indicates that the template can be used for CKS cluster deployments", - "name": "forcks", + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "name": "isdynamicallyscalable", "type": "boolean" }, { - "description": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", - "type": "map" + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", + "type": "string" + }, + { + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", + "type": "boolean" }, - {}, { "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", "name": "directdownload", "type": "boolean" }, { - "description": "the name of userdata linked to this template", - "name": "userdataname", + "description": "the template ID", + "name": "id", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the name of the zone for this template", + "name": "zonename", "type": "string" }, { - "description": "the project name of the template", - "name": "project", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the date this template was removed", - "name": "removed", - "type": "date" + "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 userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" }, { - "description": "the URL which the template/iso is registered from", - "name": "url", + "description": "the status of the template", + "name": "status", "type": "string" }, { - "description": "path of the Domain the template belongs to", - "name": "domainpath", + "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": "additional key/value details tied with template", - "name": "details", - "type": "map" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the size of the template", + "name": "size", + "type": "long" + }, + { + "description": "the project name of the template", + "name": "project", + "type": "string" } ] }, @@ -158022,76 +158698,71 @@ "name": "listVnfAppliances", "params": [ { - "description": "the ID of the virtual machine", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "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": "isrecursive", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "list vms by vpc", + "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": "vpcid", - "related": "createVPC,listVPCs,updateVPC", + "name": "name", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "The ID of the Orchestrator extension for the VM", + "description": "makes the API's response contains only the resource count", "length": 255, - "name": "extensionid", - "related": "listExtensions", + "name": "retrieveonlyresourcecount", "required": false, - "since": "4.21.0", - "type": "uuid" + "type": "boolean" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "the security group ID", "length": 255, - "name": "account", + "name": "securitygroupid", + "related": "", "required": false, - "type": "string" + "since": "4.15", + "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": "the ID of AutoScaling VM Group", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "autoscalevmgroupid", + "name": "projectid", "related": "", "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.", + "description": "flag to display the resource icon for VMs", "length": 255, - "name": "details", + "name": "showicon", "required": false, - "type": "list" + "since": "4.16.0.0", + "type": "boolean" }, { - "description": "the instances by userdata", + "description": "list by network type; true if need to list vms using Virtual Network, false otherwise", "length": 255, - "name": "userdataid", - "related": "", + "name": "forvirtualnetwork", "required": false, - "since": "4.20.1", - "type": "uuid" + "type": "boolean" }, { - "description": "list vms by iso", + "description": "", "length": 255, - "name": "isoid", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { "description": "state of the virtual machine. Possible values are: Running, Stopped, Present, Destroyed, Expunged. Present is used for the state equal not destroyed.", @@ -158101,50 +158772,50 @@ "type": "string" }, { - "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": "Whether to return the VMs' user data or not. By default, user data will not be returned.", "length": 255, - "name": "isvnf", + "name": "userdata", "required": false, - "since": "4.19.0", + "since": "4.18.0.0", "type": "boolean" }, { - "description": "", + "description": "list vms by ssh keypair name", "length": 255, - "name": "pagesize", + "name": "keypair", "required": false, - "type": "integer" + "type": "string" }, { - "description": "list by the High Availability offering; true if filtering VMs with HA enabled; false for VMs with HA disabled", + "description": "the user ID that created the VM and is under the account that owns the VM", "length": 255, - "name": "haenable", + "name": "userid", + "related": "getUser", "required": false, - "since": "4.15", - "type": "boolean" + "type": "uuid" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "The ID of the Orchestrator extension for the VM", "length": 255, - "name": "displayvm", + "name": "extensionid", + "related": "listExtensions", "required": false, - "since": "4.4", - "type": "boolean" + "since": "4.21.0", + "type": "uuid" }, { - "description": "list vms by template", + "description": "", "length": 255, - "name": "templateid", - "related": "listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "the target hypervisor for the template", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "hypervisor", + "name": "tags", "required": false, - "type": "string" + "type": "map" }, { "description": "CPU arch of the VM", @@ -158155,75 +158826,74 @@ "type": "string" }, { - "description": "flag to display the resource icon for VMs", + "description": "list vms by vpc", "length": 255, - "name": "showicon", + "name": "vpcid", + "related": "createVPC,listVPCs,updateVPC", "required": false, - "since": "4.16.0.0", - "type": "boolean" + "type": "uuid" }, { - "description": "", + "description": "the target hypervisor for the template", "length": 255, - "name": "page", + "name": "hypervisor", "required": false, - "type": "integer" + "type": "string" }, { - "description": "the IDs of the virtual machines, mutually exclusive with id", + "description": "list resources by account. Must be used with the domainId parameter.", "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": "account", "required": false, - "since": "4.4", - "type": "list" + "type": "string" }, { - "description": "the security group 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": "securitygroupid", - "related": "", + "name": "details", "required": false, - "since": "4.15", - "type": "uuid" + "type": "list" }, { - "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": "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": "name", + "name": "accumulate", "required": false, - "type": "string" + "since": "4.17.0", + "type": "boolean" }, { - "description": "list by the service offering", + "description": "list by the High Availability offering; true if filtering VMs with HA enabled; false for VMs with HA disabled", "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", + "name": "haenable", "required": false, - "since": "4.4", - "type": "uuid" + "since": "4.15", + "type": "boolean" }, { - "description": "List by keyword", + "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": "keyword", + "name": "gpuenabled", "required": false, - "type": "string" + "since": "4.21.0", + "type": "boolean" }, { - "description": "makes the API's response contains only the resource count", + "description": "the ID of AutoScaling VM Group", "length": 255, - "name": "retrieveonlyresourcecount", + "name": "autoscalevmgroupid", + "related": "", "required": false, - "type": "boolean" + "since": "4.18.0", + "type": "uuid" }, { "description": "the availability zone ID", @@ -158234,19 +158904,20 @@ "type": "uuid" }, { - "description": "Whether to return only leased instances", + "description": "the ID of the virtual machine", "length": 255, - "name": "leased", + "name": "id", + "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,createVMFromBackup,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "required": false, - "since": "4.21.0", - "type": "boolean" + "type": "uuid" }, { - "description": "list only resources belonging to the domain specified", + "description": "list by the service offering", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", "required": false, + "since": "4.4", "type": "uuid" }, { @@ -158257,219 +158928,203 @@ "type": "boolean" }, { - "description": "list by the backup offering", + "description": "the IDs of the virtual machines, mutually exclusive with id", "length": 255, - "name": "backupofferingid", - "related": "", + "name": "ids", + "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,createVMFromBackup,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "required": false, - "since": "4.17", - "type": "uuid" + "since": "4.4", + "type": "list" }, { - "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 network id", "length": 255, - "name": "accumulate", + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks", "required": false, - "since": "4.17.0", - "type": "boolean" + "type": "uuid" }, { - "description": "list vms by affinity group", + "description": "the instances by userdata", "length": 255, - "name": "affinitygroupid", + "name": "userdataid", "related": "", "required": false, + "since": "4.20.1", "type": "uuid" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "list vms by iso", "length": 255, - "name": "isrecursive", + "name": "isoid", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "list by network type; true if need to list vms using Virtual Network, false otherwise", + "description": "the group ID", "length": 255, - "name": "forvirtualnetwork", + "name": "groupid", + "related": "", "required": false, - "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": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "gpuenabled", + "name": "displayvm", "required": false, - "since": "4.21.0", + "since": "4.4", "type": "boolean" }, { - "description": "the group ID", + "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": "groupid", - "related": "", + "name": "isvnf", "required": false, - "type": "uuid" + "since": "4.19.0", + "type": "boolean" }, { - "description": "List resources by tags (key/value pairs)", + "description": "list by the backup offering", "length": 255, - "name": "tags", + "name": "backupofferingid", + "related": "", "required": false, - "type": "map" + "since": "4.17", + "type": "uuid" }, { - "description": "list by network id", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,listNetworks", + "name": "domainid", + "related": "listDomains", "required": false, "type": "uuid" }, { - "description": "list vms by ssh keypair name", + "description": "list vms by template", "length": 255, - "name": "keypair", + "name": "templateid", + "related": "registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", "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 vms by affinity group", "length": 255, - "name": "userdata", + "name": "affinitygroupid", + "related": "", "required": false, - "since": "4.18.0.0", - "type": "boolean" + "type": "uuid" } ], - "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,createVMFromBackup,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "response": [ { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", + "description": "the maximum Y resolution", + "name": "maxresolutiony", "type": "long" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", - "type": "string" + "description": "the count of GPUs on the virtual machine", + "name": "gpucount", + "type": "integer" }, { - "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": "the maximum number of display heads", - "name": "maxheads", + "description": "device ID of the root volume", + "name": "rootdeviceid", "type": "long" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" - }, - { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "the ID of the virtual machine", + "name": "id", "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 backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "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 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": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", - "type": "string" + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", - "type": "string" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "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 name of the host for the virtual machine", + "name": "hostname", "type": "string" }, - {}, { - "description": "User VM type", - "name": "vmtype", - "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", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", - "type": "string" + "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", + "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": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, { "description": "the read (IO) of disk on the VM", "name": "diskioread", @@ -158481,78 +159136,28 @@ "type": "string" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" - }, - { - "description": "the project name of the vm", - "name": "project", - "type": "string" - }, - { - "description": "OS type id of the vm", - "name": "ostypeid", - "type": "string" - }, - { - "description": "the count of GPUs on the virtual machine", - "name": "gpucount", - "type": "integer" - }, - { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", - "type": "string" - }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, - { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "description": "the video RAM size in MB", - "name": "videoram", - "type": "long" - }, - { - "description": "the user's name who deployed the virtual machine", - "name": "username", - "type": "string" - }, - { - "description": "the project id of the vm", - "name": "projectid", - "type": "string" - }, - { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", - "type": "string" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { "description": "the list of nics associated with vm", "name": "nic", "response": [ { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" }, { "description": "the traffic type of the nic", @@ -158560,58 +159165,68 @@ "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "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": "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 ID of the corresponding network", - "name": "networkid", + "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": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "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 ID of the corresponding network", + "name": "networkid", + "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" + "description": "the type of the nic", + "name": "type", + "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { @@ -158620,38 +159235,38 @@ "type": "list" }, { - "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 IPv6 address of network", - "name": "ip6address", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "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": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "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" }, { @@ -158660,13 +159275,8 @@ "type": "list" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { @@ -158675,46 +159285,66 @@ "type": "integer" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the ID of the nic", - "name": "id", + "description": "the name of the corresponding network", + "name": "networkname", "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": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" } ], "type": "set" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" }, { - "description": "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": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "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": "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", + "type": "string" + }, + { + "description": "the VM's primary IP address", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { @@ -158723,65 +159353,111 @@ "type": "boolean" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", + "description": "the pool type of the virtual machine", + "name": "pooltype", + "type": "string" + }, + { + "description": "User VM type", + "name": "vmtype", + "type": "string" + }, + { + "description": "OS type id of the vm", + "name": "ostypeid", + "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 incoming network traffic on the VM in KiB", + "name": "networkkbsread", "type": "long" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", + "description": "CPU arch of the VM", + "name": "arch", + "type": "string" + }, + { + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" + }, + {}, + { + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", + "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 speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "the maximum X resolution", + "name": "maxresolutionx", + "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 name of the gpu card to which service offering is linked", + "name": "gpucardname", + "type": "string" }, { "description": "list of security groups associated with the virtual machine", "name": "securitygroup", "response": [ - { - "description": "the ID of the security group", - "name": "id", - "type": "string" - }, - { - "description": "the 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", "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 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 list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -158790,8 +159466,8 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -158800,18 +159476,18 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -158820,48 +159496,28 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "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 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", "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", @@ -158871,15 +159527,45 @@ "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 domain name of the security group", + "name": "domain", + "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 list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "the name of the security group", + "name": "name", + "type": "string" + }, { "description": "the domain ID of the security group", "name": "domainid", @@ -158889,16 +159575,6 @@ "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", @@ -158915,8 +159591,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" }, { @@ -158925,8 +159606,8 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -158940,21 +159621,36 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", "type": "string" } ], "type": "set" }, { - "description": "the project id of the group", - "name": "projectid", + "description": "path of the Domain the security group belongs to", + "name": "domainpath", "type": "string" }, { - "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 account owning the security group", + "name": "account", "type": "string" }, { @@ -158966,33 +159662,33 @@ "name": "tags", "response": [ { - "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 domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "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": "tag value", - "name": "value", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -159000,11 +159696,6 @@ "name": "resourcetype", "type": "string" }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, { "description": "id of the resource", "name": "resourceid", @@ -159016,32 +159707,32 @@ "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", "type": "string" } ], "type": "set" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", + "description": "the starting IP of the security group rule", + "name": "startport", "type": "integer" }, { - "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 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", @@ -159049,8 +159740,13 @@ "type": "string" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", "type": "integer" }, { @@ -159059,434 +159755,310 @@ "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": "security group name", - "name": "securitygroupname", - "type": "string" + "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 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", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", - "type": "string" + "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", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, - { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, { "description": "the 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", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, + {}, { - "description": "CPU arch of the VM", - "name": "arch", + "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": "Instance lease expiry action", - "name": "leaseexpiryaction", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "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", + "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 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 total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "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", + "type": "integer" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "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": "the account associated with the virtual machine", + "name": "account", "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 ID of the domain associated with the tag", - "name": "domainid", + "description": "the type of the affinity group", + "name": "type", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the project id the tag belongs to", + "description": "the project ID of the affinity group", "name": "projectid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", - "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": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the domain ID of the affinity group", + "name": "domainid", "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 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": "public IP address id associated with vm via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the ID of the vgpu profile to which service offering is linked", - "name": "vgpuprofileid", - "type": "string" - }, - { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", - "type": "string" - }, - { - "description": "State of the Service from LB rule", - "name": "servicestate", - "type": "string" - }, - { - "description": "the id of userdata used for the VM", - "name": "userdataid", - "type": "string" - }, - { - "description": "the maximum Y resolution", - "name": "maxresolutiony", + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", "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": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", "type": "boolean" }, - { - "description": "the name of userdata used for the VM", - "name": "userdataname", - "type": "string" - }, { "description": "the date when this virtual machine was created", "name": "created", "type": "date" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", + "description": "the list of resource tags associated", + "name": "tags", "response": [ { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the ID of the affinity group", - "name": "id", + "description": "the project id the tag belongs to", + "name": "projectid", "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 account owning the affinity group", - "name": "account", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", - "type": "list" + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" } ], "type": "set" }, { - "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": "Guest vm Boot Type", - "name": "boottype", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "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", + "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 format of the template for the virtual machine", + "name": "templateformat", + "type": "string" + }, + { + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", + "type": "string" + }, + { + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { @@ -159495,11 +160067,115 @@ "type": "long" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", + "type": "string" + }, + { + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", + "type": "string" + }, + { + "description": "the user's name who deployed the virtual machine", + "name": "username", + "type": "string" + }, + { + "description": "the name of userdata used for the VM", + "name": "userdataname", + "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 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": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" + }, + { + "description": "the group name of the virtual machine", + "name": "group", + "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": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" + }, + { + "description": "the video RAM size in MB", + "name": "videoram", + "type": "long" + }, + { + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", + "type": "string" + }, + { + "description": "Base64 string containing the user data", + "name": "userdata", + "type": "string" + }, + { + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, + { + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" + }, + { + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "type": "string" + }, + { + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", + "type": "string" + } ], "since": "4.19.1" }, @@ -159522,13 +160198,6 @@ "required": true, "type": "string" }, - { - "description": "stratosphere ssp api username", - "length": 255, - "name": "username", - "required": false, - "type": "string" - }, { "description": "the zone ID", "length": 255, @@ -159550,19 +160219,32 @@ "name": "tenantuuid", "required": false, "type": "string" + }, + { + "description": "stratosphere ssp api username", + "length": 255, + "name": "username", + "required": false, + "type": "string" } ], "related": "", "response": [ + { + "description": "name", + "name": "name", + "type": "string" + }, + {}, {}, { - "description": "server id of the stratosphere ssp server", - "name": "hostid", + "description": "url of ssp endpoint", + "name": "url", "type": "string" }, { - "description": "name", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -159576,16 +160258,10 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "url of ssp endpoint", - "name": "url", + "description": "server id of the stratosphere ssp server", + "name": "hostid", "type": "string" - }, - {} + } ] }, { @@ -159594,33 +160270,33 @@ "name": "createStoragePool", "params": [ { - "description": "the URL of the storage pool", + "description": "the name for the storage pool", "length": 255, - "name": "url", + "name": "name", "required": true, "type": "string" }, { - "description": "comma separated list of storage access groups for connecting to hosts having those specific groups", + "description": "the URL of the storage pool", "length": 255, - "name": "storageaccessgroups", - "required": false, - "since": "4.21.0", + "name": "url", + "required": true, "type": "string" }, { - "description": "the tags for the storage pool", + "description": "IOPS CloudStack can provision from this storage pool", "length": 255, - "name": "tags", + "name": "capacityiops", "required": false, - "type": "string" + "type": "long" }, { - "description": "whether the storage should be managed by CloudStack", + "description": "comma separated list of storage access groups for connecting to hosts having those specific groups", "length": 255, - "name": "managed", + "name": "storageaccessgroups", "required": false, - "type": "boolean" + "since": "4.21.0", + "type": "string" }, { "description": "Whether the informed tag is a JS interpretable rule or not.", @@ -159629,21 +160305,6 @@ "required": false, "type": "boolean" }, - { - "description": "the Zone ID for the storage pool", - "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, - "type": "uuid" - }, - { - "description": "IOPS CloudStack can provision from this storage pool", - "length": 255, - "name": "capacityiops", - "required": false, - "type": "long" - }, { "description": "the Pod ID for the storage pool", "length": 255, @@ -159653,26 +160314,25 @@ "type": "uuid" }, { - "description": "the details for the storage pool", + "description": "the tags for the storage pool", "length": 255, - "name": "details", + "name": "tags", "required": false, - "type": "map" + "type": "string" }, { - "description": "the cluster ID for the storage pool", + "description": "bytes CloudStack can provision from this storage pool", "length": 255, - "name": "clusterid", - "related": "addCluster", + "name": "capacitybytes", "required": false, - "type": "uuid" + "type": "long" }, { - "description": "the name for the storage pool", + "description": "whether the storage should be managed by CloudStack", "length": 255, - "name": "name", - "required": true, - "type": "string" + "name": "managed", + "required": false, + "type": "boolean" }, { "description": "hypervisor type of the hosts in zone that will be attached to this storage pool. KVM, VMware supported as of now.", @@ -159682,11 +160342,19 @@ "type": "string" }, { - "description": "bytes CloudStack can provision from this storage pool", + "description": "the details for the storage pool", "length": 255, - "name": "capacitybytes", + "name": "details", "required": false, - "type": "long" + "type": "map" + }, + { + "description": "the Zone ID for the storage pool", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" }, { "description": "the storage provider name", @@ -159695,6 +160363,14 @@ "required": false, "type": "string" }, + { + "description": "the cluster ID for the storage pool", + "length": 255, + "name": "clusterid", + "related": "addCluster", + "required": false, + "type": "uuid" + }, { "description": "the scope of the storage: cluster or zone", "length": 255, @@ -159706,96 +160382,105 @@ "related": "cancelStorageMaintenance,findStoragePoolsForMigration,enableStorageMaintenance", "response": [ { - "description": "the storage pool custom stats", - "name": "storagecustomstats", - "type": "map" + "description": "bytes CloudStack can provision from this storage pool", + "name": "capacitybytes", + "type": "long" }, { - "description": "whether this pool is managed or not", - "name": "managed", - "type": "boolean" + "description": "the state of the storage pool", + "name": "state", + "type": "storagepoolstatus" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "total IOPS currently in use", + "name": "usediops", + "type": "long" }, { - "description": "the storage access groups for the storage pool", - "name": "storageaccessgroups", - "type": "string" + "description": "total min IOPS currently in use by volumes", + "name": "allocatediops", + "type": "long" }, { - "description": "the overprovisionfactor for the storage pool", - "name": "overprovisionfactor", + "description": "the storage pool custom stats", + "name": "storagecustomstats", + "type": "map" + }, + { + "description": "the ID of the storage pool", + "name": "id", "type": "string" }, { - "description": "the Zone name of the storage pool", - "name": "zonename", + "description": "the pool's currently used disk size", + "name": "disksizeused", + "type": "long" + }, + { + "description": "the scope of the storage pool", + "name": "scope", "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", + "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": "the hypervisor type of the storage pool", "name": "hypervisor", "type": "string" }, { - "description": "the state of the storage pool", - "name": "state", - "type": "storagepoolstatus" - }, - { - "description": "the scope of the storage pool", - "name": "scope", + "description": "the storage pool path", + "name": "path", "type": "string" }, { - "description": "the ID of the cluster for the storage pool", - "name": "clusterid", + "description": "the overprovisionfactor for the storage pool", + "name": "overprovisionfactor", "type": "string" }, { - "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 name of the storage pool", - "name": "name", - "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": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" }, { - "description": "the storage pool type", - "name": "type", + "description": "the Zone name of the storage pool", + "name": "zonename", "type": "string" }, { - "description": "the Zone ID of the storage pool", - "name": "zoneid", + "description": "the Pod name of the storage pool", + "name": "podname", "type": "string" }, - {}, { - "description": "the IP address of the storage pool", - "name": "ipaddress", - "type": "string" + "description": "the storage pool details", + "name": "details", + "type": "map" }, { "description": "the tags for the storage pool", @@ -159803,8 +160488,8 @@ "type": "string" }, { - "description": "the total disk size of the storage pool", - "name": "disksizetotal", + "description": "IOPS CloudStack can provision from this storage pool", + "name": "capacityiops", "type": "long" }, { @@ -159813,33 +160498,24 @@ "type": "map" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", - "type": "long" - }, - { - "description": "the storage pool path", - "name": "path", + "description": "the name of the storage pool", + "name": "name", "type": "string" }, { - "description": "total IOPS currently in use", - "name": "usediops", - "type": "long" - }, - { - "description": "true if this pool is suitable to migrate a volume, false otherwise", - "name": "suitableformigration", - "type": "boolean" + "description": "the Pod ID of the storage pool", + "name": "podid", + "type": "string" }, { - "description": "the storage pool details", - "name": "details", - "type": "map" + "description": "the storage access groups for the storage pool", + "name": "storageaccessgroups", + "type": "string" }, + {}, { - "description": "total min IOPS currently in use by volumes", - "name": "allocatediops", + "description": "the pool's currently allocated disk size", + "name": "disksizeallocated", "type": "long" }, { @@ -159848,24 +160524,34 @@ "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 Pod ID of the storage pool", - "name": "podid", + "description": "whether this pool is managed or not", + "name": "managed", + "type": "boolean" + }, + { + "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 storage pool type", + "name": "type", "type": "string" }, { - "description": "IOPS CloudStack can provision from this storage pool", - "name": "capacityiops", - "type": "long" + "description": "the name of the cluster for the storage pool", + "name": "clustername", + "type": "string" + }, + { + "description": "the Zone ID of the storage pool", + "name": "zoneid", + "type": "string" }, { "description": "the nfs mount options for the storage pool", @@ -159873,14 +160559,9 @@ "type": "string" }, { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" - }, - { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" } ] }, @@ -159897,11 +160578,11 @@ "type": "integer" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { "description": "the ID of the volume", @@ -159912,54 +160593,39 @@ "type": "uuid" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" } ], "related": "cancelStorageMaintenance,enableStorageMaintenance", "response": [ - { - "description": "the Zone name of the storage pool", - "name": "zonename", - "type": "string" - }, - { - "description": "the storage pool custom stats", - "name": "storagecustomstats", - "type": "map" - }, { "description": "the name of the storage pool", "name": "name", "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": "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 scope of the storage pool", + "name": "scope", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the ID of the storage pool", + "name": "id", + "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 date and time the storage pool was created", @@ -159967,9 +160633,9 @@ "type": "date" }, { - "description": "the ID of the cluster for the storage pool", - "name": "clusterid", - "type": "string" + "description": "the pool's currently used disk size", + "name": "disksizeused", + "type": "long" }, { "description": "the storage pool path", @@ -159977,66 +160643,49 @@ "type": "string" }, { - "description": "the name of the cluster for the storage pool", - "name": "clustername", + "description": "the Zone ID of the storage pool", + "name": "zoneid", "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 tags for the storage pool", - "name": "tags", - "type": "string" - }, - { - "description": "the storage access groups for the storage pool", - "name": "storageaccessgroups", - "type": "string" - }, - { - "description": "the ID of the storage pool", - "name": "id", - "type": "string" + "description": "IOPS CloudStack can provision from this storage pool", + "name": "capacityiops", + "type": "long" }, { - "description": "the storage pool type", - "name": "type", - "type": "string" + "description": "the storage pool capabilities", + "name": "storagecapabilities", + "type": "map" }, { - "description": "total IOPS currently in use", - "name": "usediops", - "type": "long" + "description": "whether this pool is managed or not", + "name": "managed", + "type": "boolean" }, - {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", "type": "boolean" }, { - "description": "the storage pool capabilities", - "name": "storagecapabilities", + "description": "the storage pool details", + "name": "details", "type": "map" }, { - "description": "the Pod name of the storage pool", - "name": "podname", + "description": "the nfs mount options for the storage pool", + "name": "nfsmountopts", "type": "string" }, { - "description": "the Pod ID of the storage pool", - "name": "podid", - "type": "string" + "description": "the storage pool custom stats", + "name": "storagecustomstats", + "type": "map" }, { "description": "the UUID of the latest async job acting on this object", @@ -160044,23 +160693,18 @@ "type": "string" }, { - "description": "the nfs mount options for the storage pool", - "name": "nfsmountopts", - "type": "string" - }, - { - "description": "the total disk size of the storage pool", - "name": "disksizetotal", + "description": "total IOPS currently in use", + "name": "usediops", "type": "long" }, { - "description": "the scope of the storage pool", - "name": "scope", + "description": "the Pod ID of the storage pool", + "name": "podid", "type": "string" }, { - "description": "the IP address of the storage pool", - "name": "ipaddress", + "description": "the overprovisionfactor for the storage pool", + "name": "overprovisionfactor", "type": "string" }, { @@ -160069,23 +160713,44 @@ "type": "string" }, { - "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 storage pool details", - "name": "details", - "type": "map" + "description": "the IP address of the storage pool", + "name": "ipaddress", + "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 host's currently used disk size", - "name": "disksizeused", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the storage pool type", + "name": "type", + "type": "string" + }, + { + "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" }, { @@ -160094,8 +160759,29 @@ "type": "storagepoolstatus" }, { - "description": "the overprovisionfactor for the storage pool", - "name": "overprovisionfactor", + "description": "the tags for the storage pool", + "name": "tags", + "type": "string" + }, + { + "description": "the storage access groups for the storage pool", + "name": "storageaccessgroups", + "type": "string" + }, + { + "description": "Storage provider for this pool", + "name": "provider", + "type": "string" + }, + { + "description": "the Pod name of the storage pool", + "name": "podname", + "type": "string" + }, + {}, + { + "description": "the Zone name of the storage pool", + "name": "zonename", "type": "string" } ] @@ -160105,13 +160791,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,29 +160798,36 @@ "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": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, {} ] @@ -160163,44 +160849,40 @@ "related": "listCiscoNexusVSMs", "response": [ { - "description": "the management IP address of the external Cisco Nexus 1000v Virtual Supervisor Module", - "name": "ipaddress", - "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": "device id of the Cisco N1KV VSM device", + "name": "vsmdeviceid", "type": "string" }, { - "description": "The mode of the VSM (standalone/HA)", - "name": "vsmconfigmode", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "device state", - "name": "vsmdevicestate", + "description": "The VSM is a switch supervisor. This is the VSM's switch domain id", + "name": "vsmdomainid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The mode of the VSM (standalone/HA)", + "name": "vsmconfigmode", "type": "string" }, { - "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": "management vlan id of the VSM", - "name": "vsmmgmtvlanid", + "description": "device state", + "name": "vsmdevicestate", "type": "string" }, { @@ -160208,30 +160890,34 @@ "name": "vsmdevicestate", "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": "device id of the Cisco N1KV VSM device", - "name": "vsmdeviceid", + "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", + "description": "management vlan id of the VSM", + "name": "vsmmgmtvlanid", "type": "string" }, { - "description": "storage vlan id of the VSM", - "name": "vsmstoragevlanid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "control vlan id of the VSM", + "name": "vsmctrlvlanid", + "type": "int" + }, + { + "description": "packet vlan id of the VSM", + "name": "vsmpktvlanid", "type": "int" } ] @@ -160242,18 +160928,17 @@ "name": "createStorageNetworkIpRange", "params": [ { - "description": "UUID of pod where the ip range belongs to", + "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": "podid", - "related": "createManagementNetworkIpRange", - "required": true, - "type": "uuid" + "name": "vlan", + "required": false, + "type": "integer" }, { - "description": "the ending IP address", + "description": "the beginning IP address", "length": 255, - "name": "endip", - "required": false, + "name": "startip", + "required": true, "type": "string" }, { @@ -160264,37 +160949,38 @@ "type": "string" }, { - "description": "the beginning IP address", + "description": "the netmask for storage network", "length": 255, - "name": "startip", + "name": "netmask", "required": true, "type": "string" }, { - "description": "the netmask for storage network", + "description": "UUID of pod where the ip range belongs to", "length": 255, - "name": "netmask", + "name": "podid", + "related": "createManagementNetworkIpRange", "required": true, - "type": "string" + "type": "uuid" }, { - "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 network uuid of storage network IP range", + "name": "networkid", + "type": "string" }, { - "description": "the end ip of the storage network IP range", - "name": "endip", + "description": "the start ip of the storage network IP range", + "name": "startip", "type": "string" }, { @@ -160303,45 +160989,45 @@ "type": "string" }, { - "description": "the gateway of the storage network IP range", - "name": "gateway", + "description": "the uuid of storage network IP range.", + "name": "id", "type": "string" }, { - "description": "the start ip of the storage network IP range", - "name": "startip", + "description": "the ID or VID of the VLAN.", + "name": "vlan", + "type": "integer" + }, + { + "description": "the Pod uuid for the storage network IP range", + "name": "podid", "type": "string" }, {}, { - "description": "the Zone uuid of the storage network IP range", - "name": "zoneid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, {}, { - "description": "the uuid of storage network IP range.", - "name": "id", + "description": "the gateway of the storage network IP range", + "name": "gateway", "type": "string" }, { - "description": "the netmask of the storage network IP range", - "name": "netmask", + "description": "the end ip of the storage network IP range", + "name": "endip", "type": "string" }, { - "description": "the ID or VID of the VLAN.", - "name": "vlan", - "type": "integer" - }, - { - "description": "the Pod uuid for the storage network IP range", - "name": "podid", + "description": "the Zone uuid of the storage network IP range", + "name": "zoneid", "type": "string" }, { - "description": "the network uuid of storage network IP range", - "name": "networkid", + "description": "the netmask of the storage network IP range", + "name": "netmask", "type": "string" } ], @@ -160353,28 +161039,27 @@ "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": "Enabled/Disabled the service provider", + "name": "enabled", + "type": "boolean" }, { "description": "the domain associated with the provider", @@ -160382,13 +161067,13 @@ "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": "the project name of the address", - "name": "project", + "description": "the account associated with the provider", + "name": "account", "type": "string" }, { @@ -160396,14 +161081,20 @@ "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 id of the ovs", - "name": "id", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { @@ -160411,20 +161102,15 @@ "name": "nspid", "type": "string" }, + {}, { - "description": "Enabled/Disabled the service provider", - "name": "enabled", - "type": "boolean" - }, - { - "description": "the account associated with the provider", - "name": "account", + "description": "the id of the ovs", + "name": "id", "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" } ] @@ -160435,19 +161121,18 @@ "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": "end date to filter stats.Use format \"yyyy-MM-dd hh:mm:ss\")", "length": 255, - "name": "name", + "name": "enddate", "required": false, - "type": "string" + "type": "date" }, { - "description": "the IDs of the system VMs, mutually exclusive with id.", + "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": "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": "name", "required": false, - "type": "list" + "type": "string" }, { "description": "", @@ -160457,74 +161142,147 @@ "type": "integer" }, { - "description": "start date to filter stats.Use format \"yyyy-MM-dd hh:mm:ss\")", + "description": "", "length": 255, - "name": "startdate", + "name": "page", "required": false, - "type": "date" + "type": "integer" }, { "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,createVMFromBackup,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,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": "List by keyword", + "description": "the IDs of the system VMs, mutually exclusive with id.", "length": 255, - "name": "keyword", + "name": "ids", + "related": "deployVnfAppliance,listVnfAppliances,createVMFromBackup,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "required": false, - "type": "string" + "type": "list" }, { - "description": "", + "description": "start date to filter stats.Use format \"yyyy-MM-dd hh:mm:ss\")", "length": 255, - "name": "page", + "name": "startdate", "required": false, - "type": "integer" + "type": "date" } ], "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 ID of the virtual machine", - "name": "id", - "type": "string" - }, { "description": "the list of VM stats", "name": "stats", + "response": [ + { + "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 VM's free memory in KB or -1 if it cannot be gathered", + "name": "memoryintfreekbs", + "type": "long" + }, + { + "description": "the target memory in VM (KB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "the total disk iops since the last stats retrieval", + "name": "diskiopstotal", + "type": "long" + }, + { + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + }, + { + "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 outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "the amount of uploaded data by the VM in MiB", + "name": "networkwrite", + "type": "string" + }, + { + "description": "the memory used by the VM in KB", + "name": "memorykbs", + "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 VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "the amount (percentage) of the VM's CPU currently used", + "name": "cpuused", + "type": "string" + }, + { + "description": "the amount of downloaded data by the VM in MiB", + "name": "networkread", + "type": "string" + } + ], "type": "list" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, + {}, + {}, { - "description": "the name of the virtual machine", - "name": "name", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the name of the virtual machine", + "name": "name", "type": "string" } ], @@ -160545,28 +161303,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", + "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" + } ] }, { @@ -160575,30 +161333,31 @@ "name": "createFirewallRule", "params": [ { - "description": "the protocol for the firewall rule. Valid values are TCP/UDP/ICMP.", + "description": "the CIDR list to forward 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 starting port of firewall rule", "length": 255, - "name": "icmpcode", + "name": "startport", "required": false, "type": "integer" }, { - "description": "type of firewallrule: system/user", + "description": "an optional field, whether to the display the rule to the end user or not", "length": 255, - "name": "type", + "name": "fordisplay", "required": false, - "type": "string" + "since": "4.4", + "type": "boolean" }, { - "description": "type of the ICMP message being sent", + "description": "error code for this icmp message", "length": 255, - "name": "icmptype", + "name": "icmpcode", "required": false, "type": "integer" }, @@ -160611,72 +161370,65 @@ "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": "type of the ICMP message being sent", "length": 255, - "name": "endport", + "name": "icmptype", "required": false, "type": "integer" }, { - "description": "the CIDR list to forward traffic from. Multiple entries must be separated by a single comma character (,).", + "description": "the protocol for the firewall rule. Valid values are TCP/UDP/ICMP.", "length": 255, - "name": "cidrlist", - "required": false, - "type": "list" + "name": "protocol", + "required": true, + "type": "string" }, { - "description": "an optional field, whether to the display the rule to the end user or not", + "description": "the ending port of firewall rule", "length": 255, - "name": "fordisplay", + "name": "endport", "required": false, - "since": "4.4", - "type": "boolean" + "type": "integer" } ], "related": "updateEgressFirewallRule", "response": [ { - "description": "the public ip address id for the firewall rule", - "name": "ipaddressid", - "type": "string" + "description": "the ending port of firewall rule's port range", + "name": "endport", + "type": "integer" }, - {}, { - "description": "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).", - "name": "destcidrlist", + "description": "the state of the rule", + "name": "state", "type": "string" }, + {}, { - "description": "the public ip address for the firewall rule", - "name": "ipaddress", + "description": "the network id of the firewall rule", + "name": "networkid", "type": "string" }, { - "description": "the state of the rule", - "name": "state", + "description": "the traffic type for the firewall rule", + "name": "traffictype", "type": "string" }, { - "description": "type of the icmp message being sent", - "name": "icmptype", + "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" - }, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the ID of the firewall rule", + "name": "id", "type": "string" }, { @@ -160690,42 +161442,42 @@ "type": "integer" }, { - "description": "the ending port of firewall rule's port range", - "name": "endport", - "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": "resource type", - "name": "resourcetype", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "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 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 domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -160734,18 +161486,18 @@ "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": "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" }, { @@ -160757,34 +161509,40 @@ "type": "list" }, { - "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 ID of the firewall rule", - "name": "id", + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + {}, + { + "description": "type of the icmp message being sent", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the public ip address for the firewall rule", + "name": "ipaddress", "type": "string" }, { - "description": "the traffic type for the firewall rule", - "name": "traffictype", + "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 protocol of the firewall rule", + "name": "protocol", + "type": "string" }, { "description": "error code for this icmp message", "name": "icmpcode", "type": "integer" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" } ] }, @@ -160794,32 +161552,23 @@ "name": "createVolume", "params": [ { - "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 ID of the virtual machine; to be used with snapshot Id, VM to which the volume gets attached after creation", + "description": "max 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": "maxiops", "required": false, - "type": "uuid" + "type": "long" }, { - "description": "the domain ID associated with the disk offering. If used with the account parameter returns the disk volume associated with the account for the specified domain.If account is NOT provided then the volume will be assigned to the caller account and domain.", + "description": "the account associated with the disk volume. Must be used with the domainId parameter.", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "max iops", + "description": "min iops", "length": 255, - "name": "maxiops", + "name": "miniops", "required": false, "type": "long" }, @@ -160832,24 +161581,33 @@ "type": "uuid" }, { - "description": "Arbitrary volume size", + "description": "the ID of the virtual machine; to be used with snapshot Id, VM to which the volume gets attached after creation", "length": 255, - "name": "size", + "name": "virtualmachineid", + "related": "deployVnfAppliance,listVnfAppliances,createVMFromBackup,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "required": false, - "type": "long" + "type": "uuid" }, { - "description": "the account associated with the disk volume. Must be used with the domainId parameter.", + "description": "the name of the disk volume", "length": 255, - "name": "account", + "name": "name", "required": false, "type": "string" }, { - "description": "the ID of the availability zone", + "description": "the ID of the disk offering. Either diskOfferingId or snapshotId must be passed in.", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "diskofferingid", + "related": "", + "required": false, + "type": "uuid" + }, + { + "description": "the domain ID associated with the disk offering. If used with the account parameter returns the disk volume associated with the account for the specified domain.If account is NOT provided then the volume will be assigned to the caller account and domain.", + "length": 255, + "name": "domainid", + "related": "listDomains", "required": false, "type": "uuid" }, @@ -160862,11 +161620,12 @@ "type": "uuid" }, { - "description": "min iops", + "description": "the ID of the availability zone", "length": 255, - "name": "miniops", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "long" + "type": "uuid" }, { "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", @@ -160876,62 +161635,66 @@ "type": "string" }, { - "description": "the ID of the disk offering. Either diskOfferingId or snapshotId must be passed in.", + "description": "Arbitrary volume size", "length": 255, - "name": "diskofferingid", - "related": "", + "name": "size", "required": false, - "type": "uuid" + "type": "long" }, { - "description": "the name of the disk volume", + "description": "an optional field, whether to display the volume to the end user or not.", "length": 255, - "name": "name", + "name": "displayvolume", "required": false, - "type": "string" + "type": "boolean" } ], "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": "ID of the availability zone", + "name": "zoneid", "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": "ID of the snapshot from which this volume was created", - "name": "snapshotid", + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "the chain info of the volume", + "name": "chaininfo", "type": "string" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, { - "description": "the path of the volume", - "name": "path", + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", + "type": "long" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" + "description": "the status of the volume", + "name": "status", + "type": "string" }, + {}, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" }, { @@ -160940,206 +161703,139 @@ "type": "integer" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, { - "description": "the project id of the vpn", - "name": "projectid", - "type": "string" + "description": "details for the volume check result, they may vary for different hypervisors", + "name": "volumecheckresult", + "type": "map" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "true if volume has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + { + "description": "state of the virtual machine", + "name": "vmstate", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - } - ], - "type": "set" + "description": "name of the disk offering", + "name": "diskofferingname", + "type": "string" }, { - "description": "size of the disk volume", - "name": "size", + "description": "the bytes actually consumed on disk", + "name": "physicalsize", "type": "long" }, { - "description": "the disk utilization", - "name": "utilization", + "description": "the state of the disk volume", + "name": "state", "type": "string" }, { - "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": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", + "description": "the path of the volume", + "name": "path", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "cluster name where the volume is allocated", + "name": "clustername", "type": "string" }, { - "description": "the domain associated with the disk volume", - "name": "domain", + "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 name of the vpn", - "name": "project", + "description": "ID of the disk volume", + "name": "id", "type": "string" }, { - "description": "path of the Domain the disk volume belongs to", - "name": "domainpath", + "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 write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", + "description": "min iops of the disk volume", + "name": "miniops", "type": "long" }, { - "description": "name of the availability zone", - "name": "zonename", - "type": "string" + "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": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", "type": "string" }, { - "description": "details for the volume repair result, they may vary for different hypervisors", - "name": "volumerepairresult", - "type": "map" - }, - { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", + "description": "shared or local storage", + "name": "storagetype", "type": "string" }, { - "description": "the bytes allocated", - "name": "virtualsize", - "type": "long" - }, - { - "description": "pod id of the volume", - "name": "podid", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "ID of the disk volume", - "name": "id", - "type": "string" + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "type": "long" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", - "type": "string" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", "type": "long" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "description": "type of the virtual machine", + "name": "vmtype", "type": "string" }, { - "description": "state of the virtual machine", - "name": "vmstate", + "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": "the date the disk volume was created", + "name": "created", + "type": "date" }, { - "description": "the format of the disk encryption if applicable", - "name": "encryptformat", + "description": "name of the virtual machine", + "name": "vmname", "type": "string" }, { - "description": "shared or local storage", - "name": "storagetype", - "type": "string" + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" }, { "description": "the read (IO) of disk on the vm", @@ -161147,174 +161843,236 @@ "type": "long" }, { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", - "type": "boolean" + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "name of the disk volume", - "name": "name", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" + }, + { + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", "type": "long" }, { - "description": "pod name of the volume", - "name": "podname", - "type": "string" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the 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" + } + ], + "type": "set" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", - "type": "string" + "description": "details for the volume repair result, they may vary for different hypervisors", + "name": "volumerepairresult", + "type": "map" }, { - "description": "the account associated with the disk volume", - "name": "account", + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", + "type": "boolean" + }, + { + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", "type": "boolean" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", + "description": "size of the disk volume", + "name": "size", "type": "long" }, { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", - "type": "boolean" + "description": "the bytes allocated", + "name": "virtualsize", + "type": "long" }, { - "description": "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": "cluster id of the volume", - "name": "clusterid", + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "type": "string" }, { - "description": "the state of the disk volume", - "name": "state", + "description": "the account associated with the disk volume", + "name": "account", "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": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the bytes actually consumed on disk", - "name": "physicalsize", - "type": "long" + "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": "name of the disk volume", + "name": "name", "type": "string" }, { - "description": "details for the volume check result, they may vary for different hypervisors", - "name": "volumecheckresult", - "type": "map" + "description": "id of the virtual machine", + "name": "virtualmachineid", + "type": "string" }, { - "description": "the status of the volume", - "name": "status", + "description": "the disk utilization", + "name": "utilization", "type": "string" }, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "pod id of the volume", + "name": "podid", "type": "string" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", "type": "boolean" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "ID of the disk offering", + "name": "diskofferingid", + "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "cluster id of the volume", + "name": "clusterid", + "type": "string" + }, + { + "description": "pod name of the volume", + "name": "podname", "type": "string" }, + {}, { "description": "ID of the service offering for root disk", "name": "serviceofferingid", "type": "string" }, + { + "description": "display name of the virtual machine", + "name": "vmdisplayname", + "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": "name of the virtual machine", - "name": "vmname", + "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": "type of the disk volume (ROOT or DATADISK)", + "name": "type", "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 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 availability zone", - "name": "zoneid", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": "type of the virtual machine", - "name": "vmtype", + "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": "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" } ] @@ -161332,10 +162090,27 @@ "type": "string" }, { - "description": "list only resources belonging to the domain specified", + "description": "the ID of the vm", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "virtualmachineid", + "related": "deployVnfAppliance,listVnfAppliances,createVMFromBackup,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "required": false, + "type": "uuid" + }, + { + "description": "the IDs of the vm snapshots, mutually exclusive with vmsnapshotid", + "length": 255, + "name": "vmsnapshotids", + "related": "listVMSnapshot,createVMSnapshot", + "required": false, + "since": "4.9", + "type": "list" + }, + { + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "", "required": false, "type": "uuid" }, @@ -161347,11 +162122,19 @@ "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "", "length": 255, - "name": "account", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" + }, + { + "description": "The ID of the VM snapshot", + "length": 255, + "name": "vmsnapshotid", + "related": "listVMSnapshot,createVMSnapshot", + "required": false, + "type": "uuid" }, { "description": "", @@ -161375,21 +162158,11 @@ "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": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "vmsnapshotids", - "related": "listVMSnapshot,createVMSnapshot", + "name": "account", "required": false, - "since": "4.9", - "type": "list" + "type": "string" }, { "description": "state of the virtual machine snapshot", @@ -161399,18 +162172,10 @@ "type": "string" }, { - "description": "the ID of the vm", - "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": false, - "type": "uuid" - }, - { - "description": "The ID of the VM snapshot", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "vmsnapshotid", - "related": "listVMSnapshot,createVMSnapshot", + "name": "domainid", + "related": "listDomains", "required": false, "type": "uuid" }, @@ -161420,96 +162185,63 @@ "name": "tags", "required": false, "type": "map" - }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" } ], "related": "createVMSnapshot", "response": [ { - "description": "VM Snapshot type", - "name": "type", - "type": "string" - }, - {}, - { - "description": "indicates if this is current snapshot", - "name": "current", - "type": "boolean" - }, - { - "description": "the domain associated with the disk volume", - "name": "domain", - "type": "string" + "description": "the state of the vm snapshot", + "name": "state", + "type": "state" }, { - "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 type of hypervisor on which snapshot is stored", - "name": "hypervisor", + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, { - "description": "path of the domain to which the disk volume belongs", - "name": "domainpath", + "description": "the parent displayName of the vm snapshot", + "name": "parentName", "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", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the create date of the vm snapshot", - "name": "created", - "type": "date" + "description": "the project id of the vpn", + "name": "projectid", + "type": "string" }, { - "description": "the state of the vm snapshot", - "name": "state", - "type": "state" + "description": "VM Snapshot type", + "name": "type", + "type": "string" }, { "description": "the list of resource tags associated", "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", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { @@ -161518,13 +162250,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 project name where tag belongs to", - "name": "project", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -161543,46 +162275,31 @@ "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", + "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" } ], "type": "set" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the parent displayName of the vm snapshot", - "name": "parentName", + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, { - "description": "the Zone ID of the vm snapshot", - "name": "zoneid", + "description": "the parent ID of the vm snapshot", + "name": "parent", "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" }, { @@ -161591,18 +162308,29 @@ "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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the Zone name of the vm snapshot", + "name": "zonename", "type": "string" }, { - "description": "the parent ID of the vm snapshot", - "name": "parent", + "description": "path of the domain to which the disk volume belongs", + "name": "domainpath", + "type": "string" + }, + { + "description": "the Zone ID of the vm snapshot", + "name": "zoneid", + "type": "string" + }, + { + "description": "the description of the vm snapshot", + "name": "description", "type": "string" }, { @@ -161611,9 +162339,39 @@ "type": "string" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "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 ID of the vm snapshot", + "name": "id", + "type": "string" + }, + { + "description": "the display name of the vm snapshot", + "name": "displayname", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the vm name of the vm snapshot", + "name": "virtualmachinename", "type": "string" + }, + { + "description": "the create date of the vm snapshot", + "name": "created", + "type": "date" } ], "since": "4.2.0" @@ -161623,13 +162381,6 @@ "isasync": true, "name": "moveNetworkAclItem", "params": [ - { - "description": "The ID of the network ACL rule that is being moved to a new position.", - "length": 255, - "name": "id", - "required": true, - "type": "string" - }, { "description": "The ID of the rule that is right after 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 last position of the network ACL list.", "length": 255, @@ -161637,13 +162388,6 @@ "required": false, "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).", - "length": 255, - "name": "aclconsistencyhash", - "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, @@ -161658,36 +162402,24 @@ "name": "previousaclruleid", "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", - "type": "string" }, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "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": "aclconsistencyhash", + "required": false, "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 ID of the network ACL rule that is being moved to a new position.", + "length": 255, + "name": "id", + "required": true, "type": "string" - }, + } + ], + "related": "", + "response": [ { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -161703,8 +162435,8 @@ "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -161713,8 +162445,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" }, { @@ -161723,52 +162455,83 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "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": "tag key name", + "name": "key", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "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": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the name of the ACL this item belongs to", + "name": "aclname", + "type": "string" + }, { "description": "the ID of the ACL Item", "name": "id", "type": "string" }, { - "description": "the ID of the ACL this item belongs to", - "name": "aclid", + "description": "Number of the ACL Item", + "name": "number", + "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": "an explanation on why this ACL rule is being applied", - "name": "reason", + "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": "the ending port of ACL's port range", + "name": "endport", "type": "string" }, { @@ -161777,14 +162540,19 @@ "type": "string" }, { - "description": "the name of the ACL this item belongs to", - "name": "aclname", + "description": "an explanation on why this ACL rule is being applied", + "name": "reason", "type": "string" }, { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the state of the rule", + "name": "state", + "type": "string" + }, + { + "description": "the traffic type for the ACL", + "name": "traffictype", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", @@ -161792,24 +162560,14 @@ "type": "integer" }, { - "description": "the ending port of ACL's port range", - "name": "endport", + "description": "Action of ACL Item. Allow/Deny", + "name": "action", "type": "string" }, { - "description": "the state of the rule", - "name": "state", + "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": "error code for this icmp message", - "name": "icmpcode", - "type": "integer" } ] }, @@ -161836,16 +162594,15 @@ } ], "response": [ - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, {}, { @@ -161853,10 +162610,11 @@ "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" } ] }, @@ -161872,13 +162630,6 @@ "required": false, "type": "integer" }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, { "description": "DHCP server device ID", "length": 255, @@ -161887,9 +162638,9 @@ "type": "long" }, { - "description": "List by keyword", + "description": "Type of DHCP device", "length": 255, - "name": "keyword", + "name": "dhcpservertype", "required": false, "type": "string" }, @@ -161902,37 +162653,38 @@ "type": "uuid" }, { - "description": "Type of DHCP device", + "description": "List by keyword", "length": 255, - "name": "dhcpservertype", + "name": "keyword", "required": false, "type": "string" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" } ], "related": "", "response": [ { - "description": "device id of ", - "name": "id", + "description": "url", + "name": "url", "type": "string" }, + {}, { "description": "name of the provider", "name": "dhcpservertype", "type": "string" }, - {}, { "description": "the physical network to which this external dhcp device belongs to", "name": "physicalnetworkid", "type": "string" }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "name of the provider", "name": "provider", @@ -161944,8 +162696,14 @@ "type": "string" }, { - "description": "url", - "name": "url", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + { + "description": "device id of ", + "name": "id", "type": "string" } ] @@ -161967,45 +162725,28 @@ "related": "cancelStorageMaintenance", "response": [ { - "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 storage pool custom stats", - "name": "storagecustomstats", - "type": "map" + "description": "the scope of the storage pool", + "name": "scope", + "type": "string" }, { - "description": "the total disk size of the storage pool", - "name": "disksizetotal", + "description": "the pool's currently allocated disk size", + "name": "disksizeallocated", "type": "long" }, { - "description": "total IOPS currently in use", - "name": "usediops", + "description": "bytes CloudStack can provision from this storage pool", + "name": "capacitybytes", "type": "long" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the overprovisionfactor for the storage pool", - "name": "overprovisionfactor", + "description": "the Pod ID of the storage pool", + "name": "podid", "type": "string" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", + "description": "the total disk size of the storage pool", + "name": "disksizetotal", "type": "long" }, { @@ -162014,13 +162755,13 @@ "type": "long" }, { - "description": "the tags for the storage pool", - "name": "tags", + "description": "the overprovisionfactor for the storage pool", + "name": "overprovisionfactor", "type": "string" }, { - "description": "the hypervisor type of the storage pool", - "name": "hypervisor", + "description": "the name of the storage pool", + "name": "name", "type": "string" }, { @@ -162029,54 +162770,79 @@ "type": "date" }, { - "description": "the ID of the storage pool", - "name": "id", - "type": "string" + "description": "the storage pool capabilities", + "name": "storagecapabilities", + "type": "map" }, { - "description": "the Pod ID of the storage pool", - "name": "podid", + "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": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" + }, + { + "description": "the storage pool details", + "name": "details", + "type": "map" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + { + "description": "total min IOPS currently in use by volumes", + "name": "allocatediops", + "type": "long" + }, { "description": "the storage pool path", "name": "path", "type": "string" }, { - "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": "Storage provider for this pool", - "name": "provider", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the ID of the cluster for the storage pool", - "name": "clusterid", - "type": "string" + "description": "whether this pool is managed or not", + "name": "managed", + "type": "boolean" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", - "type": "long" + "description": "the nfs mount options for the storage pool", + "name": "nfsmountopts", + "type": "string" }, { - "description": "the storage pool capabilities", - "name": "storagecapabilities", - "type": "map" + "description": "Storage provider for this pool", + "name": "provider", + "type": "string" }, { - "description": "the IP address of the storage pool", - "name": "ipaddress", + "description": "the ID of the storage pool", + "name": "id", "type": "string" }, { - "description": "the storage pool type", - "name": "type", - "type": "string" + "description": "total IOPS currently in use", + "name": "usediops", + "type": "long" }, { "description": "the Pod name of the storage pool", @@ -162084,65 +162850,62 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the storage pool custom stats", + "name": "storagecustomstats", + "type": "map" }, { - "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", - "type": "string" + "description": "the state of the storage pool", + "name": "state", + "type": "storagepoolstatus" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the Zone name of the storage pool", + "name": "zonename", "type": "string" }, { - "description": "the name of the storage pool", - "name": "name", + "description": "the ID of the cluster for the storage pool", + "name": "clusterid", "type": "string" }, { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", - "type": "boolean" + "description": "the tags for the storage pool", + "name": "tags", + "type": "string" }, { - "description": "the scope of the storage pool", - "name": "scope", + "description": "the storage access groups for the storage pool", + "name": "storageaccessgroups", "type": "string" }, { - "description": "the nfs mount options for the storage pool", - "name": "nfsmountopts", + "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": "the IP address of the storage pool", + "name": "ipaddress", + "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": "the state of the storage pool", - "name": "state", - "type": "storagepoolstatus" + "description": "the pool's currently used disk size", + "name": "disksizeused", + "type": "long" }, - { - "description": "whether this pool is managed or not", - "name": "managed", - "type": "boolean" - } + {} ] }, { @@ -162165,22 +162928,22 @@ "name": "displaytext", "type": "string" }, + {}, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, {} ], "since": "4.19.0" @@ -162206,59 +162969,42 @@ "type": "string" }, { - "description": "the list params the api accepts", - "name": "params", + "description": "api response fields", + "name": "response", "response": [ { - "description": "comma separated related apis to get the parameter", - "name": "related", - "type": "string" - }, - { - "description": "version of CloudStack the api was introduced in", - "name": "since", + "description": "the name of the api response field", + "name": "name", "type": "string" }, { - "description": "true if this parameter is required for the api request", - "name": "required", - "type": "boolean" - }, - { - "description": "description of the api parameter", + "description": "description of the api response field", "name": "description", "type": "string" }, - {}, { - "description": "parameter type", + "description": "response field 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": "api response fields", + "name": "response", + "type": "set" } ], "type": "set" }, { - "description": "the name of the api command", - "name": "name", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "comma separated related apis", - "name": "related", + "description": "the name of the api command", + "name": "name", "type": "string" }, - {}, { "description": "description of the api", "name": "description", @@ -162269,48 +163015,65 @@ "name": "type", "type": "string" }, + {}, + {}, { "description": "version of CloudStack the api was introduced in", "name": "since", "type": "string" }, { - "description": "api response fields", - "name": "response", + "description": "comma separated related apis", + "name": "related", + "type": "string" + }, + { + "description": "the list params the api accepts", + "name": "params", "response": [ { - "description": "response field type", - "name": "type", + "description": "the name of the api parameter", + "name": "name", "type": "string" }, { - "description": "api response fields", - "name": "response", - "type": "set" + "description": "true if this parameter is required for the api request", + "name": "required", + "type": "boolean" }, { - "description": "description of the api response field", + "description": "length of the parameter", + "name": "length", + "type": "int" + }, + {}, + { + "description": "comma separated related apis to get the parameter", + "name": "related", + "type": "string" + }, + { + "description": "version of CloudStack the api was introduced in", + "name": "since", + "type": "string" + }, + { + "description": "description of the api parameter", "name": "description", "type": "string" }, { - "description": "the name of the api response field", - "name": "name", + "description": "parameter type", + "name": "type", "type": "string" } ], "type": "set" }, - {}, { "description": "true if api is asynchronous", "name": "isasync", "type": "boolean" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" } ], "since": "4.1.0" @@ -162330,17 +163093,6 @@ } ], "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", @@ -162351,6 +163103,17 @@ "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" } ] }, @@ -162360,12 +163123,11 @@ "name": "createVMSnapshot", "params": [ { - "description": "The ID of the vm", + "description": "The description of the snapshot", "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": "description", + "required": false, + "type": "string" }, { "description": "quiesce vm if true", @@ -162375,101 +163137,164 @@ "type": "boolean" }, { - "description": "snapshot memory if true", + "description": "The display name of the snapshot", "length": 255, - "name": "snapshotmemory", + "name": "name", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "The description of the snapshot", + "description": "snapshot memory if true", "length": 255, - "name": "description", + "name": "snapshotmemory", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "The display name of the snapshot", + "description": "The ID of the vm", "length": 255, - "name": "name", - "required": false, - "type": "string" + "name": "virtualmachineid", + "related": "deployVnfAppliance,listVnfAppliances,createVMFromBackup,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "required": true, + "type": "uuid" } ], "related": "", "response": [ + {}, + {}, + { + "description": "the ID of the vm snapshot", + "name": "id", + "type": "string" + }, + { + "description": "the account associated with the disk volume", + "name": "account", + "type": "string" + }, + { + "description": "path of the domain to which the disk volume belongs", + "name": "domainpath", + "type": "string" + }, { "description": "the vm ID of the vm snapshot", "name": "virtualmachineid", "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 domain associated with the disk volume", + "name": "domain", + "type": "string" + }, + { + "description": "the parent displayName of the vm snapshot", + "name": "parentName", + "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 UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the description of the vm snapshot", + "name": "description", + "type": "string" + }, + { + "description": "the display name of the vm snapshot", + "name": "displayname", "type": "string" }, + { + "description": "the state of the vm snapshot", + "name": "state", + "type": "state" + }, { "description": "the Zone name of the vm snapshot", "name": "zonename", "type": "string" }, + { + "description": "the parent ID of the vm snapshot", + "name": "parent", + "type": "string" + }, + { + "description": "the Zone ID of the vm snapshot", + "name": "zoneid", + "type": "string" + }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the account associated with the tag", + "name": "account", "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 domain associated with the tag", - "name": "domain", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag value", + "name": "value", "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 name where tag belongs to", + "name": "project", "type": "string" }, { @@ -162481,8 +163306,8 @@ "type": "set" }, { - "description": "the parent ID of the vm snapshot", - "name": "parent", + "description": "the name of the vm snapshot", + "name": "name", "type": "string" }, { @@ -162491,40 +163316,19 @@ "type": "boolean" }, { - "description": "the account associated with the disk volume", - "name": "account", - "type": "string" - }, - {}, - { - "description": "the parent displayName of the vm snapshot", - "name": "parentName", - "type": "string" - }, - { - "description": "the ID of the vm snapshot", - "name": "id", - "type": "string" - }, - { - "description": "the description of the vm snapshot", - "name": "description", + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, - { - "description": "the state of the vm snapshot", - "name": "state", - "type": "state" - }, { "description": "the project id of the vpn", "name": "projectid", "type": "string" }, { - "description": "VM Snapshot type", - "name": "type", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { "description": "the type of hypervisor on which snapshot is stored", @@ -162532,55 +163336,14 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", - "type": "string" - }, - { - "description": "the Zone ID of the vm snapshot", - "name": "zoneid", - "type": "string" - }, - { - "description": "the display name of the vm snapshot", - "name": "displayname", - "type": "string" - }, - { - "description": "path of the domain to which the disk volume belongs", - "name": "domainpath", + "description": "VM Snapshot type", + "name": "type", "type": "string" }, { "description": "the vm name of the vm snapshot", "name": "virtualmachinename", "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - {}, - { - "description": "the name of the vm snapshot", - "name": "name", - "type": "string" - }, - { - "description": "the domain associated with the disk volume", - "name": "domain", - "type": "string" } ], "since": "4.2.0" @@ -162601,26 +163364,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": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, {} ], "since": "4.2.0" @@ -162631,31 +163394,31 @@ "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", + "description": "the uuid of Tungsten-Fabric tag type", "length": 255, - "name": "keyword", + "name": "tagtypeuuid", "required": false, "type": "string" }, { - "description": "", + "description": "the ID of zone", "length": 255, - "name": "pagesize", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "the uuid of Tungsten-Fabric tag type", + "description": "List by keyword", "length": 255, - "name": "tagtypeuuid", + "name": "keyword", "required": false, "type": "string" }, @@ -162669,10 +163432,11 @@ ], "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": "Tungsten-Fabric provider zone name", @@ -162680,27 +163444,26 @@ "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": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "Tungsten-Fabric tag type uuid", "name": "uuid", "type": "string" }, - {}, { "description": "Tungsten-Fabric tag type name", "name": "name", "type": "string" - } + }, + { + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" + }, + {} ] }, { @@ -162709,19 +163472,19 @@ "name": "extractSnapshot", "params": [ { - "description": "the ID of the snapshot", + "description": "the ID of the zone where the snapshot is located", "length": 255, - "name": "id", - "related": "listSnapshots", + "name": "zoneid", + "related": "listZones", "required": true, "since": "4.20.0", "type": "uuid" }, { - "description": "the ID of the zone where the snapshot is located", + "description": "the ID of the snapshot", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "id", + "related": "listSnapshots", "required": true, "since": "4.20.0", "type": "uuid" @@ -162730,28 +163493,18 @@ "related": "", "response": [ { - "description": "the time and date the object was created", - "name": "created", - "type": "date" - }, - { - "description": "if mode = upload then url of the uploaded entity. if mode = download the url from which the entity can be downloaded", - "name": "url", - "type": "string" - }, - { - "description": "the name of the extracted object", - "name": "name", + "description": "the status of the extraction", + "name": "status", "type": "string" }, { - "description": "the status of the extraction", - "name": "status", + "description": "zone ID the object was extracted from", + "name": "zoneid", "type": "string" }, { - "description": "type of the storage", - "name": "storagetype", + "description": "zone name the object was extracted from", + "name": "zonename", "type": "string" }, { @@ -162760,13 +163513,18 @@ "type": "string" }, { - "description": "zone ID the object was extracted from", - "name": "zoneid", + "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", "type": "string" }, { - "description": "the state of the extracted object", - "name": "state", + "description": "type of the storage", + "name": "storagetype", "type": "string" }, { @@ -162775,70 +163533,70 @@ "type": "string" }, { - "description": "the upload id of extracted object", - "name": "extractId", + "description": "", + "name": "resultstring", "type": "string" }, { - "description": "the percentage of the entity uploaded to the specified location", - "name": "uploadpercentage", - "type": "integer" + "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", "type": "string" }, { - "description": "the account id to which the extracted object belongs", - "name": "accountid", - "type": "string" - }, - { - "description": "zone name the object was extracted from", - "name": "zonename", + "description": "the name of the extracted object", + "name": "name", "type": "string" }, - {}, { - "description": "", - "name": "resultstring", - "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": "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 upload id of extracted object", + "name": "extractId", + "type": "string" } ], "since": "4.20.0" }, { - "description": "List registered keypairs", - "isasync": false, - "name": "listSSHKeyPairs", - "params": [ - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, + "description": "List registered keypairs", + "isasync": false, + "name": "listSSHKeyPairs", + "params": [ { - "description": "", + "description": "the ID of the ssh keypair", "length": 255, - "name": "page", + "name": "id", + "related": "listSSHKeyPairs", "required": false, - "type": "integer" + "type": "uuid" }, { - "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", @@ -162848,20 +163606,11 @@ "type": "string" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", - "length": 255, - "name": "projectid", - "related": "", - "required": false, - "type": "uuid" - }, - { - "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.", @@ -162871,51 +163620,70 @@ "type": "boolean" }, { - "description": "A public key fingerprint to look for", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "fingerprint", + "name": "account", "required": false, "type": "string" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "", "length": 255, - "name": "listall", + "name": "pagesize", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "list only resources belonging to the domain specified", + "description": "", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "", "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": "If set to false, list only resources belonging to the command's caller; if set to true - list resources 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": "", "response": [ + {}, { - "description": "Name of the keypair", - "name": "name", + "description": "Fingerprint of the public key", + "name": "fingerprint", "type": "string" }, { - "description": "the project name of the keypair owner", - "name": "project", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "the domain id of the keypair owner", - "name": "domainid", + "description": "the domain name of the keypair owner", + "name": "domain", + "type": "string" + }, + { + "description": "ID of the ssh keypair", + "name": "id", "type": "string" }, { @@ -162923,41 +163691,36 @@ "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 project id of the keypair owner", - "name": "projectid", + "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": "Name of the keypair", + "name": "name", "type": "string" }, { - "description": "Fingerprint of the public key", - "name": "fingerprint", + "description": "the project id of the keypair owner", + "name": "projectid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - {}, - { - "description": "ID of the ssh keypair", - "name": "id", + "description": "the project name of the keypair owner", + "name": "project", "type": "string" }, { - "description": "the domain name of the keypair owner", - "name": "domain", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -162978,9 +163741,9 @@ "related": "", "response": [ { - "description": "the ID of the storage pool", - "name": "id", - "type": "string" + "description": "true if this pool is suitable to migrate a volume, false otherwise", + "name": "suitableformigration", + "type": "boolean" }, { "description": "whether this pool is managed or not", @@ -162988,53 +163751,59 @@ "type": "boolean" }, { - "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 Zone ID of the storage pool", - "name": "zoneid", + "description": "the Pod name of the storage pool", + "name": "podname", "type": "string" }, { - "description": "the storage pool capabilities", - "name": "storagecapabilities", - "type": "map" + "description": "the ID of the cluster for the storage pool", + "name": "clusterid", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, { - "description": "the hypervisor type of the storage pool", - "name": "hypervisor", + "description": "the nfs mount options for the storage pool", + "name": "nfsmountopts", "type": "string" }, { - "description": "the storage pool details", - "name": "details", - "type": "map" + "description": "the ID of the storage pool", + "name": "id", + "type": "string" }, { - "description": "the storage pool type", - "name": "type", + "description": "the name of the storage pool", + "name": "name", "type": "string" }, { - "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", - "type": "boolean" + "description": "the pool's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" }, { - "description": "the storage pool path", - "name": "path", + "description": "the IP address of the storage pool", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the Zone ID of the storage pool", + "name": "zoneid", "type": "string" }, { @@ -163042,41 +163811,56 @@ "name": "state", "type": "storagepoolstatus" }, + { + "description": "Storage provider for this pool", + "name": "provider", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, { "description": "the scope of the storage pool", "name": "scope", "type": "string" }, { - "description": "the tags for the storage pool", - "name": "tags", + "description": "the hypervisor type of the storage pool", + "name": "hypervisor", "type": "string" }, { - "description": "the Pod name of the storage pool", - "name": "podname", + "description": "the total disk size of the storage pool", + "name": "disksizetotal", + "type": "long" + }, + { + "description": "the storage pool type", + "name": "type", "type": "string" }, + {}, { - "description": "the Zone name of the storage pool", - "name": "zonename", + "description": "the storage pool path", + "name": "path", "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", + "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": "total min IOPS currently in use by volumes", + "name": "allocatediops", + "type": "long" }, { "description": "the UUID of the latest async job acting on this object", @@ -163084,18 +163868,18 @@ "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": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", - "type": "boolean" + "description": "the storage pool details", + "name": "details", + "type": "map" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", + "description": "IOPS CloudStack can provision from this storage pool", + "name": "capacityiops", "type": "long" }, { @@ -163104,55 +163888,39 @@ "type": "long" }, { - "description": "true if this pool is suitable to migrate a volume, false otherwise", - "name": "suitableformigration", - "type": "boolean" - }, - { - "description": "the IP address of the storage pool", - "name": "ipaddress", + "description": "the Zone name of the storage pool", + "name": "zonename", "type": "string" }, { - "description": "IOPS CloudStack can provision from this storage pool", - "name": "capacityiops", - "type": "long" + "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": "the date and time the storage pool was created", + "name": "created", + "type": "date" }, { - "description": "the name of the cluster for the storage pool", - "name": "clustername", + "description": "the Pod ID of the storage pool", + "name": "podid", "type": "string" }, { - "description": "the ID of the cluster for the storage pool", - "name": "clusterid", + "description": "the overprovisionfactor for the storage pool", + "name": "overprovisionfactor", "type": "string" }, { - "description": "Storage provider for this pool", - "name": "provider", - "type": "string" + "description": "the storage pool capabilities", + "name": "storagecapabilities", + "type": "map" }, { "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 name of the storage pool", - "name": "name", - "type": "string" } ] }, @@ -163188,130 +163956,135 @@ ], "related": "", "response": [ + { + "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": "the ID of the snapshot policy", + "name": "id", + "type": "string" + }, + { + "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 list of zones in which snapshot backup is scheduled", - "name": "zone", - "type": "set" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + { + "description": "the name of the disk volume", + "name": "volumename", + "type": "string" }, { "description": "is this policy for display to the regular user", "name": "fordisplay", "type": "boolean" }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "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": "tag value", - "name": "value", + "description": "customer associated with the tag", + "name": "customer", "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 value", + "name": "value", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the account associated with the tag", + "name": "account", "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", + "description": "the ID of the disk volume", + "name": "volumeid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "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": "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": "time the snapshot is scheduled to be taken.", - "name": "schedule", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - } + {} ] }, { @@ -163320,16 +164093,17 @@ "name": "quotaSummary", "params": [ { - "description": "", + "description": "Optional, If domain Id is given and the caller is domain admin then the statement is generated for domain.", "length": 255, - "name": "pagesize", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "integer" + "type": "uuid" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, @@ -163341,12 +164115,11 @@ "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": "page", "required": false, - "type": "uuid" + "type": "integer" }, { "description": "List by keyword", @@ -163366,71 +164139,71 @@ "related": "", "response": [ { - "description": "domain name", - "name": "domain", + "description": "domain id", + "name": "domainid", "type": "string" }, + { + "description": "end date", + "name": "enddate", + "type": "date" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "currency", "name": "currency", "type": "string" }, - { - "description": "account balance", - "name": "balance", - "type": "bigdecimal" - }, { "description": "account state", "name": "state", "type": "state" }, { - "description": "account name", - "name": "account", - "type": "string" + "description": "quota usage of this period", + "name": "quota", + "type": "bigdecimal" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "account id", + "name": "accountid", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "account balance", + "name": "balance", + "type": "bigdecimal" }, - {}, { - "description": "domain id", - "name": "domainid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "end date", - "name": "enddate", + "description": "start date", + "name": "startdate", "type": "date" }, + { + "description": "domain name", + "name": "domain", + "type": "string" + }, { "description": "if the account has the quota config enabled", "name": "quotaenabled", "type": "boolean" }, + {}, { - "description": "account id", - "name": "accountid", + "description": "account name", + "name": "account", "type": "string" - }, - { - "description": "quota usage of this period", - "name": "quota", - "type": "bigdecimal" - }, - { - "description": "start date", - "name": "startdate", - "type": "date" } ], "since": "4.7.0" @@ -163457,34 +164230,35 @@ "type": "date" }, { - "description": "the domain id that executed the async command", - "name": "domainid", + "description": "the account that executed the async command", + "name": "account", "type": "string" }, { - "description": "the unique ID of the instance/entity object related to the job", - "name": "jobinstanceid", + "description": "the user that executed the async command", + "name": "userid", "type": "string" }, { - "description": "the msid of the management server on which the job is running", - "name": "managementserverid", + "description": "the instance/entity object related to the job", + "name": "jobinstancetype", "type": "string" }, { - "description": "the result type", - "name": "jobresulttype", - "type": "string" + "description": "the progress information of the PENDING job", + "name": "jobprocstatus", + "type": "integer" }, { - "description": "the user that executed the async command", - "name": "userid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "the progress information of the PENDING job", - "name": "jobprocstatus", - "type": "integer" + "description": "the account id that executed the async command", + "name": "accountid", + "type": "string" }, { "description": "the result code for the job", @@ -163492,46 +164266,40 @@ "type": "integer" }, { - "description": "the instance/entity object related to the job", - "name": "jobinstancetype", + "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 completed date of the job", + "name": "completed", + "type": "date" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the result reason", + "name": "jobresult", + "type": "responseobject" }, { - "description": "the account id that executed the async command", - "name": "accountid", + "description": "the async command executed", + "name": "cmd", "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 result type", + "name": "jobresulttype", "type": "string" }, { - "description": "the account that executed the async command", - "name": "account", + "description": "the unique ID of the instance/entity object related to the job", + "name": "jobinstanceid", "type": "string" }, { - "description": "the result reason", - "name": "jobresult", - "type": "responseobject" + "description": "the msid of the management server on which the job is running", + "name": "managementserverid", + "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -163539,8 +164307,13 @@ }, {}, { - "description": "the async command executed", - "name": "cmd", + "description": "the domain that executed the async command", + "name": "domainpath", + "type": "string" + }, + { + "description": "the management server name of the host", + "name": "managementservername", "type": "string" } ] @@ -163551,16 +164324,16 @@ "name": "registerNetscalerControlCenter", "params": [ { - "description": "URL of the netscaler controlcenter appliance.", + "description": "Credentials to reach netscaler controlcenter device", "length": 255, - "name": "ipaddress", + "name": "password", "required": true, "type": "string" }, { - "description": "Credentials to reach netscaler controlcenter device", + "description": "URL of the netscaler controlcenter appliance.", "length": 255, - "name": "password", + "name": "ipaddress", "required": true, "type": "string" }, @@ -163581,36 +164354,15 @@ ], "related": "addNetscalerLoadBalancer", "response": [ - {}, - { - "description": "the public interface of the load balancer", - "name": "publicinterface", - "type": "string" - }, { "description": "private IP of the NetScaler representing GSLB site", "name": "gslbproviderprivateip", "type": "string" }, - { - "description": "device capacity", - "name": "lbdevicecapacity", - "type": "long" - }, {}, { - "description": "true if NetScaler device is provisioned exclusively to be a GSLB service provider", - "name": "isexclusivegslbprovider", - "type": "boolean" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "public IP of the NetScaler representing GSLB site", - "name": "gslbproviderpublicip", + "description": "the physical network to which this netscaler device belongs to", + "name": "physicalnetworkid", "type": "string" }, { @@ -163619,18 +164371,18 @@ "type": "string" }, { - "description": "true if device is dedicated for an account", - "name": "lbdevicededicated", + "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", + "description": "the public interface of the load balancer", + "name": "publicinterface", "type": "string" }, { - "description": "device id of the netscaler load balancer", - "name": "lbdeviceid", + "description": "the private interface of the load balancer", + "name": "privateinterface", "type": "string" }, { @@ -163639,23 +164391,28 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "device capacity", + "name": "lbdevicecapacity", + "type": "long" + }, + { + "description": "public IP of the NetScaler representing GSLB site", + "name": "gslbproviderpublicip", "type": "string" }, { - "description": "true if NetScaler device is provisioned to be a GSLB service provider", - "name": "gslbprovider", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the private interface of the load balancer", - "name": "privateinterface", + "description": "name of the provider", + "name": "provider", "type": "string" }, { - "description": "the physical network to which this netscaler device belongs to", - "name": "physicalnetworkid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -163663,11 +164420,27 @@ "name": "lbdevicestate", "type": "string" }, + { + "description": "device id of the netscaler load balancer", + "name": "lbdeviceid", + "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 to be a GSLB service provider", + "name": "gslbprovider", + "type": "boolean" + }, + {} ] }, { @@ -163675,6 +164448,13 @@ "isasync": true, "name": "createCounter", "params": [ + { + "description": "Name of the counter.", + "length": 255, + "name": "name", + "required": true, + "type": "string" + }, { "description": "Value of the counter e.g. oid in case of snmp.", "length": 255, @@ -163696,59 +164476,52 @@ "name": "source", "required": true, "type": "string" - }, - { - "description": "Name of the counter.", - "length": 255, - "name": "name", - "required": true, - "type": "string" } ], "related": "", "response": [ + { + "description": "Value in case of snmp or other specific counters.", + "name": "value", + "type": "string" + }, { "description": "Source of the counter.", "name": "source", "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", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, {}, { - "description": "Value in case of snmp or other specific counters.", - "name": "value", + "description": "Provider of the counter.", + "name": "provider", "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" }, { "description": "the id of the Counter", "name": "id", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } + {} ] }, { @@ -163758,23 +164531,23 @@ "params": [], "related": "", "response": [ + {}, { "description": "Event Type", "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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } + {} ] }, { @@ -163794,23 +164567,13 @@ "related": "", "response": [ { - "description": "The number of jobs in progress", - "name": "pendingjobscount", - "type": "long" - }, - { - "description": "The host agents this management server is responsible for", - "name": "agents", - "type": "list" - }, - { - "description": "the state of the management server", - "name": "state", - "type": "state" + "description": "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" }, { @@ -163818,33 +164581,43 @@ "name": "agentscount", "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": "Indicates whether maintenance has been initiated", + "name": "maintenanceinitiated", + "type": "boolean" + }, + { + "description": "the state of the management server", + "name": "state", + "type": "state" + }, + {}, + { + "description": "The number of jobs in progress", + "name": "pendingjobscount", + "type": "long" + }, { "description": "The id of the management server", "name": "managementserverid", "type": "string" }, { - "description": "Indicates whether maintenance has been initiated", - "name": "maintenanceinitiated", + "description": "Indicates whether CloudStack is ready to shutdown", + "name": "readyforshutdown", "type": "boolean" }, { - "description": "Indicates whether a shutdown has been triggered", - "name": "shutdowntriggered", - "type": "boolean" - }, - {}, - {} + "description": "The host agents this management server is responsible for", + "name": "agents", + "type": "list" + } ], "since": "4.19.0" }, @@ -163854,23 +164627,23 @@ "name": "addCluster", "params": [ { - "description": "the URL", + "description": "Name of virtual switch used for guest traffic in the cluster. This would override zone wide traffic label setting.", "length": 255, - "name": "url", + "name": "guestvswitchname", "required": false, "type": "string" }, { - "description": "the password for the VSM associated with this cluster", + "description": "Ovm3 native OCFS2 clustering enabled for cluster", "length": 255, - "name": "vsmpassword", + "name": "ovm3cluster", "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 username for the cluster", "length": 255, - "name": "publicvswitchtype", + "name": "username", "required": false, "type": "string" }, @@ -163883,106 +164656,96 @@ "type": "uuid" }, { - "description": "type of the cluster: CloudManaged, ExternalManaged", - "length": 255, - "name": "clustertype", - "required": true, - "type": "string" - }, - { - "description": "Name of virtual switch used for public traffic in the cluster. This would override zone wide traffic label setting.", + "description": "UUID of the extension", "length": 255, - "name": "publicvswitchname", + "name": "extensionid", + "related": "listExtensions", "required": false, - "type": "string" + "since": "4.21.0", + "type": "uuid" }, { - "description": "the username for the cluster", + "description": "Ovm3 native pooling enabled for cluster", "length": 255, - "name": "username", + "name": "ovm3pool", "required": false, "type": "string" }, { - "description": "the password for the host", + "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": "password", + "name": "publicvswitchtype", "required": false, "type": "string" }, { - "description": "Allocation state of this cluster for allocation of new resources", + "description": "hypervisor type of the cluster: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator,Ovm3,External", "length": 255, - "name": "allocationstate", - "required": false, + "name": "hypervisor", + "required": true, "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": "Name of virtual switch used for public traffic in the cluster. This would override zone wide traffic label setting.", "length": 255, - "name": "externaldetails", + "name": "publicvswitchname", "required": false, - "since": "4.21.0", - "type": "map" + "type": "string" }, { - "description": "the Zone ID for the cluster", + "description": "the cluster name", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "clustername", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "UUID of the extension", + "description": "type of the cluster: CloudManaged, ExternalManaged", "length": 255, - "name": "extensionid", - "related": "listExtensions", - "required": false, - "since": "4.21.0", - "type": "uuid" + "name": "clustertype", + "required": true, + "type": "string" }, { - "description": "comma separated list of storage access groups for the hosts in the cluster", + "description": "the password for the host", "length": 255, - "name": "storageaccessgroups", + "name": "password", "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": "the ipaddress of the VSM associated with this cluster", "length": 255, - "name": "arch", + "name": "vsmipaddress", "required": false, - "since": "4.20", "type": "string" }, { - "description": "Type of virtual switch used for guest traffic in the cluster. Allowed values are, vmwaresvs (for VMware standard vSwitch) and vmwaredvs (for VMware distributed vSwitch)", + "description": "Ovm3 vip to use for pool (and cluster)", "length": 255, - "name": "guestvswitchtype", + "name": "ovm3vip", "required": false, "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", + "description": "Type of virtual switch used for guest traffic in the cluster. Allowed values are, vmwaresvs (for VMware standard vSwitch) and vmwaredvs (for VMware distributed vSwitch)", "length": 255, - "name": "ovm3cluster", + "name": "guestvswitchtype", "required": false, "type": "string" }, @@ -163994,76 +164757,77 @@ "type": "string" }, { - "description": "the ipaddress of the VSM associated with this 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": "vsmipaddress", + "name": "externaldetails", "required": false, - "type": "string" + "since": "4.21.0", + "type": "map" }, { - "description": "Name of virtual switch used for guest traffic in the cluster. This would override zone wide traffic label setting.", + "description": "the CPU arch of the cluster. Valid options are: x86_64, aarch64", "length": 255, - "name": "guestvswitchname", + "name": "arch", "required": false, + "since": "4.20", "type": "string" }, { - "description": "hypervisor type of the cluster: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator,Ovm3,External", + "description": "the Zone ID for the cluster", "length": 255, - "name": "hypervisor", + "name": "zoneid", + "related": "listZones", "required": true, + "type": "uuid" + }, + { + "description": "the URL", + "length": 255, + "name": "url", + "required": false, "type": "string" }, { - "description": "the cluster name", + "description": "the password for the VSM associated with this cluster", "length": 255, - "name": "clustername", - "required": true, + "name": "vsmpassword", + "required": false, "type": "string" } ], "related": "", "response": [ { - "description": "comma-separated list of storage access groups for the host", - "name": "storageaccessgroups", + "description": "CPU Arch of the hosts in the cluster", + "name": "arch", "type": "string" }, - {}, { - "description": "The memory overcommit ratio of the cluster", - "name": "memoryovercommitratio", + "description": "the type of the cluster", + "name": "clustertype", "type": "string" }, { - "description": "The ID of extension for this cluster", - "name": "extensionid", + "description": "The memory overcommit ratio of the cluster", + "name": "memoryovercommitratio", "type": "string" }, + {}, + {}, + {}, { "description": "the allocation state of the cluster", "name": "allocationstate", "type": "string" }, { - "description": "the Zone ID of the cluster", - "name": "zoneid", - "type": "string" - }, - { - "description": "whether this cluster is managed by cloudstack", - "name": "managedstate", - "type": "string" - }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The ID of extension for this cluster", + "name": "extensionid", "type": "string" }, { - "description": "the cluster ID", - "name": "id", + "description": "the Pod name of the cluster", + "name": "podname", "type": "string" }, { @@ -164072,39 +164836,18 @@ "type": "string" }, { - "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": "Meta data associated with the zone (key/value pairs)", - "name": "resourcedetails", - "type": "map" - }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "comma-separated list of storage access groups on the zone", - "name": "zonestorageaccessgroups", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the Zone name of the cluster", - "name": "zonename", + "description": "Ovm3 VIP to use for pooling and/or clustering", + "name": "ovm3vip", "type": "string" }, { - "description": "the cluster name", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -164112,18 +164855,13 @@ "name": "capacity", "response": [ { - "description": "the capacity currently in allocated", - "name": "capacityallocated", - "type": "long" - }, - { - "description": "the capacity currently in use", - "name": "capacityused", + "description": "the total capacity available", + "name": "capacitytotal", "type": "long" }, { - "description": "the percentage of capacity currently in use", - "name": "percentused", + "description": "The tag for the capacity type", + "name": "tag", "type": "string" }, { @@ -164132,56 +164870,71 @@ "type": "string" }, { - "description": "the Zone ID", - "name": "zoneid", + "description": "the capacity type", + "name": "type", + "type": "short" + }, + { + "description": "the Pod ID", + "name": "podid", "type": "string" }, { - "description": "the Cluster ID", - "name": "clusterid", + "description": "the Pod name", + "name": "podname", "type": "string" }, { - "description": "the Cluster name", - "name": "clustername", + "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" }, { - "description": "the Pod ID", - "name": "podid", + "description": "the Zone ID", + "name": "zoneid", "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 percentage of capacity currently in use", + "name": "percentused", "type": "string" }, { - "description": "the Pod name", - "name": "podname", + "description": "the Cluster ID", + "name": "clusterid", "type": "string" }, { - "description": "the Zone name", - "name": "zonename", + "description": "the Cluster name", + "name": "clustername", "type": "string" } ], "type": "list" }, { - "description": "CPU Arch of the hosts in the cluster", - "name": "arch", + "description": "comma-separated list of storage access groups on the pod", + "name": "podstorageaccessgroups", + "type": "string" + }, + { + "description": "comma-separated list of storage access groups for the host", + "name": "storageaccessgroups", + "type": "string" + }, + { + "description": "the cluster ID", + "name": "id", "type": "string" }, { @@ -164189,30 +164942,50 @@ "name": "podid", "type": "string" }, + { + "description": "whether this cluster is managed by cloudstack", + "name": "managedstate", + "type": "string" + }, + { + "description": "the cluster name", + "name": "name", + "type": "string" + }, + { + "description": "the Zone ID of the cluster", + "name": "zoneid", + "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 cluster", "name": "hypervisortype", "type": "string" }, { - "description": "the Pod name of the cluster", - "name": "podname", + "description": "Meta data associated with the zone (key/value pairs)", + "name": "resourcedetails", + "type": "map" + }, + { + "description": "the Zone name of the cluster", + "name": "zonename", "type": "string" }, { - "description": "Ovm3 VIP to use for pooling and/or clustering", - "name": "ovm3vip", + "description": "comma-separated list of storage access groups on the zone", + "name": "zonestorageaccessgroups", "type": "string" }, { "description": "The name of extension for this cluster", "name": "extensionname", "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" } ] }, @@ -164231,11 +165004,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", @@ -164246,12 +165025,6 @@ "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,21 +165045,16 @@ "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,createVMFromBackup,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "required": true, "type": "uuid" } ], - "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,createVMFromBackup,scaleVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "response": [ { - "description": "the state of the virtual machine", - "name": "state", - "type": "string" - }, - { - "description": "CPU arch of the VM", - "name": "arch", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { @@ -164295,152 +165063,324 @@ "type": "string" }, { - "description": "Instance lease expiry action", - "name": "leaseexpiryaction", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "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", + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", "type": "boolean" }, - {}, - { - "description": "Os type ID of the virtual machine", - "name": "guestosid", - "type": "string" - }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", - "type": "string" + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { - "description": "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": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "the account owning the affinity group", - "name": "account", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", + "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 domain name of the affinity group", - "name": "domain", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", + "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 broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "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": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", "type": "list" }, { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", "type": "list" }, { - "description": "the description of the affinity group", - "name": "description", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" } ], "type": "set" }, { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", - "type": "string" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "the video RAM size in MB", + "name": "videoram", + "type": "long" + }, + { + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the maximum number of display heads", + "name": "maxheads", + "type": "long" }, { - "description": "the ID of the vgpu profile to which service offering is linked", - "name": "vgpuprofileid", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "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": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "the 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 speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "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": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the 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 account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + } + ], + "type": "set" }, { - "description": "the maximum X resolution", - "name": "maxresolutionx", - "type": "long" + "description": "the project id of the vm", + "name": "projectid", + "type": "string" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", + "type": "string" + }, + { + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", + "type": "string" }, { "description": "the count of GPUs on the virtual machine", @@ -164448,114 +165388,123 @@ "type": "integer" }, { - "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 date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", + "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", "type": "boolean" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, - {}, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", + "type": "string" }, { - "description": "the name of the vgpu profile to which service offering is linked", - "name": "vgpuprofilename", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" + "description": "Guest vm Boot Mode", + "name": "bootmode", + "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": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "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": "OS type id of the vm", + "name": "ostypeid", + "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "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", + "description": "the name of the host for the virtual machine", + "name": "hostname", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "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": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", - "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 total number of network traffic bytes sent", - "name": "sentbytes", + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", "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": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { @@ -164564,138 +165513,158 @@ "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 ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", + "type": "string" + }, + { + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, + { + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "type": "string" + }, + { + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", "response": [ { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" + "description": "the ID of the affinity group", + "name": "id", + "type": "string" }, { - "description": "the project name of the group", - "name": "project", + "description": "the type of the affinity group", + "name": "type", "type": "string" }, { - "description": "the domain ID of the security group", - "name": "domainid", + "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 domain name of the security group", + "description": "the domain name of the affinity group", "name": "domain", "type": "string" }, { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" }, { - "description": "the description of the security group", + "description": "the description of the affinity 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 account owning the affinity group", + "name": "account", + "type": "string" + }, + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" + }, + { + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + } + ], + "type": "set" + }, + { + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "type": "string" + }, + { + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", + "response": [ + { + "description": "the 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 project name of the group", + "name": "project", + "type": "string" }, { "description": "the list of egress rules associated with the security group", "name": "egressrule", "response": [ { - "description": "the code for the ICMP message response", - "name": "icmpcode", + "description": "the starting IP of the security group rule", + "name": "startport", "type": "integer" }, { - "description": "account owning the security group rule", - "name": "account", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, { - "description": "security group name", - "name": "securitygroupname", + "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", + "description": "account owning the security group rule", + "name": "account", "type": "string" }, { @@ -164704,18 +165673,18 @@ "type": "string" }, { - "description": "the starting IP of the security group rule", - "name": "startport", + "description": "the type of the ICMP message response", + "name": "icmptype", "type": "integer" }, { - "description": "the 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", + "description": "the ending IP of the security group rule ", + "name": "endport", "type": "integer" }, { @@ -164723,415 +165692,304 @@ "name": "tags", "response": [ { - "description": "resource type", - "name": "resourcetype", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the 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 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 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": "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": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "resource type", + "name": "resourcetype", "type": "string" } ], "type": "set" }, { - "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", - "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 number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" }, { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", + "description": "the list of resource tags associated with the rule", + "name": "tags", "response": [ { - "description": "account owning the security group rule", - "name": "account", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", + "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": "security group name", - "name": "securitygroupname", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "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": "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": "OS name of the vm", - "name": "osdisplayname", - "type": "string" - }, - { - "description": "the project name of the vm", - "name": "project", - "type": "string" - }, - { - "description": "the pool type of the virtual machine", - "name": "pooltype", - "type": "string" - }, - { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" - }, - { - "description": "the list of nics associated with vm", - "name": "nic", - "response": [ - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "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 broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "the ID of the nic", - "name": "id", - "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" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + } + ], + "type": "set" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the description of the security group", + "name": "description", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "path of the Domain the security group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "the account owning the security group", + "name": "account", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the domain ID of the security group", + "name": "domainid", "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "the domain name of the security group", + "name": "domain", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" + "description": "the 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 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": "account owning the security group rule", + "name": "account", + "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": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "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 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" + } + ], + "type": "set" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + } + ], + "type": "set" } ], "type": "set" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", - "type": "string" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "description": "the group name of the virtual machine", - "name": "group", - "type": "string" + "description": "the 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", + "description": "User VM type", + "name": "vmtype", "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 ID of the virtual machine", @@ -165139,79 +165997,90 @@ "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "the project name of the vm", + "name": "project", "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 name of the virtual machine", - "name": "name", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "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": "Guest vm Boot Mode", - "name": "bootmode", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", - "type": "string" + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, + { + "description": "the maximum Y resolution", + "name": "maxresolutiony", + "type": "long" + }, + { + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", + "description": "the 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", - "type": "long" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, + {}, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "CPU arch of the VM", + "name": "arch", "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "Base64 string containing the user data", + "name": "userdata", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", @@ -165224,216 +166093,120 @@ "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" - }, - { - "description": "Base64 string containing the user data", - "name": "userdata", - "type": "string" - }, - { - "description": "ssh key-pairs", - "name": "keypairs", + "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": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", "type": "long" }, { - "description": "User VM type", - "name": "vmtype", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" - }, - { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the video RAM size in MB", - "name": "videoram", - "type": "long" - }, - { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" - }, - { - "description": "Instance lease duration in days", - "name": "leaseduration", - "type": "integer" + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the maximum Y resolution", - "name": "maxresolutiony", - "type": "long" + "description": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "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 number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", + "description": "the maximum X resolution", + "name": "maxresolutionx", "type": "long" }, + {}, { - "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": "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": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "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": "tag key name", - "name": "key", - "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 VM's primary IP address", - "name": "ipaddress", - "type": "string" - }, - { - "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 VM's disk read in KiB", "name": "diskkbsread", "type": "long" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "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": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" } ] }, @@ -165451,23 +166224,16 @@ "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", - "required": false, - "type": "integer" - }, - { - "description": "the name of the account associated with the host. Must be used with domainId.", + "description": "List by keyword", "length": 255, - "name": "account", + "name": "keyword", "required": false, "type": "string" }, @@ -165493,6 +166259,13 @@ "related": "reconnectHost", "required": false, "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" } ], "related": "", @@ -165504,8 +166277,8 @@ }, {}, { - "description": "the ID of the dedicated resource", - "name": "id", + "description": "the name of the host", + "name": "hostname", "type": "string" }, { @@ -165514,32 +166287,75 @@ "type": "string" }, { - "description": "the ID of the host", - "name": "hostid", + "description": "the Account ID of the host", + "name": "accountid", "type": "string" }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the UUID of the latest async 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 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": "Get diagnostics and files from system VMs", + "isasync": true, + "name": "getDiagnosticsData", + "params": [ + { + "description": "The ID of the system VM instance to retrieve diagnostics data files from", + "length": 255, + "name": "targetid", + "related": "", + "required": true, + "type": "uuid" }, { - "description": "the Account ID of the host", - "name": "accountid", + "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" + } + ], + "since": "4.14.0.0" }, { "description": "upload an existing ISO into the CloudStack cloud.", @@ -165554,112 +166370,111 @@ "type": "boolean" }, { - "description": "true if you want to register the ISO to be publicly available to all users, false otherwise.", + "description": "an optional accountName. Must be used with domainId.", "length": 255, - "name": "ispublic", + "name": "account", "required": false, - "type": "boolean" + "type": "string" }, { - "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", + "description": "the name of the volume/template/iso", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "name", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "the format for the volume/template/iso. Possible values include QCOW2, OVA, and VHD.", - "length": 255, - "name": "format", - "required": true, + "description": "the display text of the ISO. This is usually used for display purposes.", + "length": 4096, + "name": "displaytext", + "required": false, "type": "string" }, { - "description": "an optional domainId. If the account parameter is used, domainId must also be used.", + "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": "domainid", - "related": "listDomains", + "name": "ostypeid", + "related": "", "required": false, "type": "uuid" }, { - "description": "the name of the volume/template/iso", + "description": "the format for the volume/template/iso. Possible values include QCOW2, OVA, and VHD.", "length": 255, - "name": "name", + "name": "format", "required": true, "type": "string" }, { - "description": "true if the ISO or its derivatives are extractable; default is false", + "description": "an optional domainId. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "isextractable", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "an optional accountName. Must be used with domainId.", + "description": "true if this ISO is bootable. If not passed explicitly its assumed to be true", "length": 255, - "name": "account", + "name": "bootable", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "true if this ISO is bootable. If not passed explicitly its assumed to be true", + "description": "true if you want to register the ISO to be publicly available to all users, false otherwise.", "length": 255, - "name": "bootable", + "name": "ispublic", "required": false, "type": "boolean" }, { - "description": "the checksum value of this volume/template/iso The parameter containing the checksum will be considered a MD5sum if it is not prefixed\n and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to\n use another algorithm the hexadecimal string is to be prefixed with a string of the form,\n \"{}\", not including the double quotes. In this is the exact string\n representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not\n contain an algorithm called SHA256 or one called sha-256, only SHA-256.", + "description": "the ID of the zone the volume/template/iso is to be hosted on", "length": 255, - "name": "checksum", - "required": false, - "type": "string" + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" }, { - "description": "the ID of the OS type that best represents the OS of this ISO. If the ISO is bootable this parameter needs to be passed", + "description": "Upload volume/template/iso for the project", "length": 255, - "name": "ostypeid", + "name": "projectid", "related": "", "required": false, "type": "uuid" }, { - "description": "the display text of the ISO. This is usually used for display purposes.", - "length": 4096, - "name": "displaytext", + "description": "true if the ISO or its derivatives are extractable; default is false", + "length": 255, + "name": "isextractable", "required": false, - "type": "string" + "type": "boolean" } ], "related": "", "response": [ { - "description": "the timestamp after which the signature expires", - "name": "expires", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "encrypted data to be sent in the POST request.", - "name": "metadata", - "type": "string" + "description": "the template/volume ID", + "name": "id", + "type": "uuid" }, { - "description": "signature to be sent in the POST request.", - "name": "signature", + "description": "encrypted data to be sent in the POST request.", + "name": "metadata", "type": "string" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -165671,107 +166486,65 @@ "type": "url" }, { - "description": "the template/volume ID", - "name": "id", - "type": "uuid" + "description": "signature to be sent in the POST request.", + "name": "signature", + "type": "string" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the timestamp after which the signature expires", + "name": "expires", + "type": "string" }, {} ], "since": "4.13" }, { - "description": "Get diagnostics and files from system VMs", + "description": "Deletes a autoscale vm group.", "isasync": true, - "name": "getDiagnosticsData", + "name": "deleteAutoScaleVmGroup", "params": [ { - "description": "A comma separated list of diagnostics data files to be retrieved. Defaults are taken from global settings if none has been provided.", + "description": "true if all VMs have to be cleaned up, false otherwise", "length": 255, - "name": "files", + "name": "cleanup", "required": false, - "type": "list" + "since": "4.18.0", + "type": "boolean" }, { - "description": "The ID of the system VM instance to retrieve diagnostics data files from", + "description": "the ID of the autoscale group", "length": 255, - "name": "targetid", + "name": "id", "related": "", "required": true, "type": "uuid" } ], - "related": "", "response": [ - { - "description": "Storage URL to download retrieve diagnostics data files", - "name": "url", - "type": "string" - }, - {}, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ], - "since": "4.14.0.0" - }, - { - "description": "Deletes a autoscale vm group.", - "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, - "name": "cleanup", - "required": false, - "since": "4.18.0", - "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": "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" - } + {} ] }, { @@ -165782,31 +166555,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", @@ -165819,96 +166592,96 @@ ], "related": "", "response": [ - { - "description": "device id of the Palo Alto firewall", - "name": "fwdeviceid", - "type": "string" - }, { "description": "the timeout (in seconds) for requests to the external firewall", "name": "timeout", "type": "string" }, { - "description": "the zone ID of the external firewall", - "name": "zoneid", + "description": "the private interface of the external firewall", + "name": "privateinterface", "type": "string" }, { - "description": "the usage interface of the external firewall", - "name": "usageinterface", + "description": "name of the provider", + "name": "provider", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the zone ID of the external firewall", + "name": "zoneid", + "type": "string" }, { - "description": "device capacity", - "name": "fwdevicecapacity", - "type": "long" + "description": "device state", + "name": "fwdevicestate", + "type": "string" }, { - "description": "the private interface of the external firewall", - "name": "privateinterface", + "description": "the public security zone of the external firewall", + "name": "publiczone", "type": "string" }, { - "description": "device state", - "name": "fwdevicestate", + "description": "the number of times to retry requests to the external firewall", + "name": "numretries", "type": "string" }, + {}, + {}, { "description": "the management IP address of the external firewall", "name": "ipaddress", "type": "string" }, { - "description": "the private security zone of the external firewall", - "name": "privatezone", + "description": "the username that's used to log in to the external firewall", + "name": "username", "type": "string" }, { - "description": "device name", - "name": "fwdevicename", - "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": "device capacity", + "name": "fwdevicecapacity", + "type": "long" + }, + { + "description": "the usage interface of the external firewall", + "name": "usageinterface", "type": "string" }, - {}, - {}, { - "description": "the username that's used to log in to the external firewall", - "name": "username", + "description": "device id of the Palo Alto firewall", + "name": "fwdeviceid", "type": "string" }, { - "description": "name of the provider", - "name": "provider", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the public interface of the external firewall", - "name": "publicinterface", + "description": "the private security zone of the external firewall", + "name": "privatezone", "type": "string" }, { - "description": "the physical network to which this Palo Alto firewall belongs to", - "name": "physicalnetworkid", + "description": "device name", + "name": "fwdevicename", "type": "string" }, { - "description": "the public security zone of the external firewall", - "name": "publiczone", + "description": "the physical network to which this Palo Alto firewall belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the number of times to retry requests to the external firewall", - "name": "numretries", + "description": "the public interface of the external firewall", + "name": "publicinterface", "type": "string" } ] @@ -165927,10 +166700,19 @@ "type": "uuid" }, { - "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, + "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" }, { @@ -165948,45 +166730,53 @@ "type": "string" }, { - "description": "an optional field, whether to the display the rule to the end user or not", + "description": "the cidr list to forward traffic from", "length": 255, - "name": "fordisplay", + "name": "cidrlist", "required": false, - "since": "4.4", - "type": "boolean" + "since": "4.22", + "type": "list" }, { - "description": "the description of the load balancer rule", - "length": 4096, - "name": "description", + "description": "the name of the load balancer rule", + "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, - "name": "customid", + "description": "the description of the load balancer rule", + "length": 4096, + "name": "description", "required": false, - "since": "4.4", "type": "string" } ], "related": "listLoadBalancerRules", "response": [ { - "description": "the public ip address id", - "name": "publicipid", + "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 ID of the load balancer rule", - "name": "domainid", + "description": "path of the domain to which the load balancer rule belongs", + "name": "domainpath", "type": "string" }, - {}, { - "description": "the id of the guest network the lb rule belongs to", - "name": "networkid", + "description": "the load balancer algorithm (source, roundrobin, leastconn)", + "name": "algorithm", + "type": "string" + }, + { + "description": "the domain of the load balancer rule", + "name": "domain", "type": "string" }, { @@ -165995,13 +166785,25 @@ "type": "string" }, { - "description": "path of the domain to which the load balancer rule belongs", - "name": "domainpath", + "description": "the account of the load balancer rule", + "name": "account", "type": "string" }, + {}, { - "description": "the CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,).", - "name": "cidrlist", + "description": "the public ip address id", + "name": "publicipid", + "type": "string" + }, + {}, + { + "description": "the project name of the load balancer", + "name": "project", + "type": "string" + }, + { + "description": "the project id of the load balancer", + "name": "projectid", "type": "string" }, { @@ -166009,23 +166811,43 @@ "name": "publicip", "type": "string" }, + { + "description": "the name of the zone the load balancer rule belongs to", + "name": "zonename", + "type": "string" + }, + { + "description": "the protocol of the loadbalanacer rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the load balancer rule ID", + "name": "id", + "type": "string" + }, + { + "description": "the public port", + "name": "publicport", + "type": "string" + }, + { + "description": "the CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,).", + "name": "cidrlist", + "type": "string" + }, { "description": "the list of resource tags associated with load balancer", "name": "tags", "response": [ { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -166034,13 +166856,8 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -166049,58 +166866,37 @@ "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": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag value", + "name": "value", "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 domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + } + ], + "type": "list" }, { "description": "the current status of the latest async job acting on this object", @@ -166108,48 +166904,33 @@ "type": "integer" }, { - "description": "the id of the zone the rule belongs to", - "name": "zoneid", - "type": "string" - }, - { - "description": "the protocol of the loadbalanacer rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the name of the load balancer", - "name": "name", + "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 load balancer algorithm (source, roundrobin, leastconn)", - "name": "algorithm", + "description": "the private port", + "name": "privateport", "type": "string" }, { - "description": "the public port", - "name": "publicport", + "description": "the domain ID of the load balancer rule", + "name": "domainid", "type": "string" }, { - "description": "the project name of the load balancer", - "name": "project", + "description": "the id of the zone the rule belongs to", + "name": "zoneid", "type": "string" }, { - "description": "the account of the load balancer rule", - "name": "account", + "description": "the name of the load balancer", + "name": "name", "type": "string" }, { - "description": "the private port", - "name": "privateport", + "description": "the id of the guest network the lb rule belongs to", + "name": "networkid", "type": "string" } ] @@ -166160,10 +166941,10 @@ "name": "enableAccount", "params": [ { - "description": "Enables specified account in this domain.", + "description": "Account id", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "id", + "related": "enableAccount,listAccounts", "required": false, "type": "uuid" }, @@ -166175,10 +166956,10 @@ "type": "string" }, { - "description": "Account id", + "description": "Enables specified account in this domain.", "length": 255, - "name": "id", - "related": "enableAccount,listAccounts", + "name": "domainid", + "related": "listDomains", "required": false, "type": "uuid" } @@ -166186,28 +166967,8 @@ "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": "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 cpu cores available to be created for this account", + "name": "cpuavailable", "type": "string" }, { @@ -166216,9 +166977,9 @@ "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) available to be used for this account", + "name": "secondarystorageavailable", + "type": "string" }, { "description": "the total volume available for this account", @@ -166226,133 +166987,103 @@ "type": "string" }, { - "description": "the total number of projects being administrated by this account", - "name": "projecttotal", - "type": "long" + "description": "the total number of networks the account can own", + "name": "networklimit", + "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", "type": "long" }, { - "description": "the total number of virtual machines stopped for this account", - "name": "vmstopped", - "type": "integer" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "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 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 networks available to be created for this account", - "name": "networkavailable", + "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": "the total number of templates available to be created by this account", + "name": "templateavailable", "type": "string" }, { - "description": "true if account is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the total number of public ip addresses available for this account to acquire", - "name": "ipavailable", + "description": "the total number of virtual machines that can be deployed by this account", + "name": "vmlimit", "type": "string" }, { - "description": "the total number of virtual machines running for this account", - "name": "vmrunning", - "type": "integer" - }, - { - "description": "the total backup storage space (in GiB) owned by the account", - "name": "backupstoragetotal", - "type": "long" - }, - { - "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", - "name": "apikeyaccess", - "type": "apikeyaccess" - }, - { - "description": "the name of the account", - "name": "name", + "description": "the total memory (in MB) available to be created for this account", + "name": "memoryavailable", "type": "string" }, { - "description": "the total secondary storage space (in GiB) available to be used for this account", - "name": "secondarystorageavailable", + "description": "the total secondary storage space (in GiB) the account can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "the id of the account", + "name": "id", "type": "string" }, { - "description": "the state of the account", - "name": "state", + "description": "the name of the role", + "name": "rolename", "type": "string" }, { - "description": "the list of acl groups that account belongs to", - "name": "groups", - "type": "list" + "description": "the total number of buckets available to this account", + "name": "bucketavailable", + "type": "string" }, { - "description": "the total memory (in MB) owned by account", - "name": "memorytotal", - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "the total number of public ip addresses this account can acquire", + "name": "iplimit", "type": "string" }, { - "description": "the total number of snapshots which can be stored by this account", - "name": "snapshotlimit", + "description": "the total number of backups available to this account", + "name": "backupavailable", "type": "string" }, { - "description": "the total number of templates available to be created by this account", - "name": "templateavailable", + "description": "name of the Domain the account belongs to", + "name": "domain", "type": "string" }, { - "description": "the total volume which can be used by this account", - "name": "volumelimit", - "type": "string" + "description": "details for the account", + "name": "accountdetails", + "type": "map" }, { - "description": "the total number of snapshots available for this account", - "name": "snapshotavailable", + "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", - "type": "string" + "description": "The tagged resource limit and count for the account", + "name": "taggedresources", + "type": "list" }, { - "description": "the total number of templates which have been created by this account", - "name": "templatetotal", + "description": "the total number of vpcs owned by account", + "name": "vpctotal", "type": "long" }, { @@ -166361,83 +167092,84 @@ "type": "string" }, { - "description": "the total number of vpcs the account can own", - "name": "vpclimit", - "type": "string" - }, - { - "description": "the default zone of the account", - "name": "defaultzoneid", + "description": "the total primary storage space (in GiB) available to be used for this account", + "name": "primarystorageavailable", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "true if the account requires cleanup", + "name": "iscleanuprequired", + "type": "boolean" }, { - "description": "the total number of vpcs owned by account", - "name": "vpctotal", - "type": "long" + "description": "true if account is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the id of the account", - "name": "id", + "description": "the total volume which can be used by this account", + "name": "volumelimit", "type": "string" }, { - "description": "id of the Domain the account belongs to", - "name": "domainid", - "type": "string" + "description": "the total object storage space (in GiB) owned by the account", + "name": "objectstoragetotal", + "type": "long" }, + {}, { - "description": "the total volume being used by this account", - "name": "volumetotal", + "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "path of the Domain the account belongs to", - "name": "domainpath", - "type": "string" + "description": "the total secondary storage space (in GiB) owned by account", + "name": "secondarystoragetotal", + "type": "float" }, { - "description": "the total number of buckets which can be stored by this account", - "name": "bucketlimit", + "description": "id of the Domain the account belongs to", + "name": "domainid", "type": "string" }, { - "description": "name of the Domain the account belongs to", - "name": "domain", - "type": "string" + "description": "the total number of virtual machines deployed by this account", + "name": "vmtotal", + "type": "long" }, { - "description": "the total number of public ip addresses this account can acquire", - "name": "iplimit", - "type": "string" + "description": "the total number of snapshots stored by this account", + "name": "snapshottotal", + "type": "long" }, { - "description": "the total number of vpcs available to be created for this account", - "name": "vpcavailable", + "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", "type": "string" }, { - "description": "the total number of virtual machines available for this account to acquire", - "name": "vmavailable", + "description": "the total number of networks available to be created for this account", + "name": "networkavailable", "type": "string" }, { - "description": "the total number of projects available for administration by this account", - "name": "projectavailable", + "description": "the total number of public ip addresses available for this account to acquire", + "name": "ipavailable", "type": "string" }, { - "description": "the total memory (in MB) the account can own", - "name": "memorylimit", + "description": "the total number of gpus the account can own", + "name": "gpulimit", "type": "string" }, { @@ -166446,50 +167178,44 @@ "type": "string" }, { - "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", + "type": "long" }, + {}, { - "description": "the total number of cpu cores available to be created for this account", - "name": "cpuavailable", + "description": "the total number of virtual machines available for this account to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "the total number of virtual machines that can be deployed by this account", - "name": "vmlimit", - "type": "string" + "description": "the total number of cpu cores owned by account", + "name": "cputotal", + "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 memory (in MB) available to be created for this account", - "name": "memoryavailable", + "description": "the total number of vpcs the account can own", + "name": "vpclimit", "type": "string" }, - {}, { "description": "the list of users associated with account", "name": "user", "response": [ { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" - }, - { - "description": "the user lastname", - "name": "lastname", - "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 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)", @@ -166497,13 +167223,18 @@ "type": "apikeyaccess" }, { - "description": "the user name", - "name": "username", + "description": "the account name of the user", + "name": "account", "type": "string" }, { - "description": "the user firstname", - "name": "firstname", + "description": "the timezone user was created in", + "name": "timezone", + "type": "string" + }, + { + "description": "the domain name of the user", + "name": "domain", "type": "string" }, { @@ -166512,13 +167243,33 @@ "type": "string" }, { - "description": "the user email address", - "name": "email", + "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 account type of the user", + "name": "accounttype", + "type": "integer" + }, + { + "description": "the name of the role", + "name": "rolename", "type": "string" }, { - "description": "the domain name of the user", - "name": "domain", + "description": "the account ID of the user", + "name": "accountid", + "type": "string" + }, + { + "description": "the type of the role", + "name": "roletype", "type": "string" }, { @@ -166527,14 +167278,14 @@ "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 user lastname", + "name": "lastname", + "type": "string" }, { "description": "the secret key of the user", @@ -166547,13 +167298,8 @@ "type": "string" }, { - "description": "the account ID of the user", - "name": "accountid", - "type": "string" - }, - { - "description": "the name of the role", - "name": "rolename", + "description": "the user email address", + "name": "email", "type": "string" }, { @@ -166562,147 +167308,182 @@ "type": "resourceiconresponse" }, { - "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 api key of the user", - "name": "apikey", + "description": "the user firstname", + "name": "firstname", "type": "string" }, { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the ID of the role", + "name": "roleid", + "type": "string" }, { - "description": "the type of the role", - "name": "roletype", + "description": "the api key of the user", + "name": "apikey", "type": "string" }, { "description": "the user ID", "name": "id", "type": "string" - }, - { - "description": "the account name of the user", - "name": "account", - "type": "string" - }, - { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", - "type": "boolean" - }, - { - "description": "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", + "description": "the total number of buckets which can be stored by this account", + "name": "bucketlimit", "type": "string" }, { - "description": "the total number of snapshots stored by this account", - "name": "snapshottotal", + "description": "the total number of snapshots which can be stored by this account", + "name": "snapshotlimit", + "type": "string" + }, + { + "description": "the total number of buckets stored by this account", + "name": "buckettotal", "type": "long" }, { - "description": "the total secondary storage space (in GiB) owned by account", - "name": "secondarystoragetotal", - "type": "float" + "description": "the default zone of the account", + "name": "defaultzoneid", + "type": "string" }, { - "description": "the total object storage space (in GiB) the account can own", - "name": "objectstoragelimit", + "description": "the total number of cpu cores the account can own", + "name": "cpulimit", "type": "string" }, { - "description": "the total number of backups available to this account", - "name": "backupavailable", + "description": "the total number of snapshots available for this account", + "name": "snapshotavailable", "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by account", - "name": "primarystoragetotal", + "description": "the total number of virtual machines running for this account", + "name": "vmrunning", + "type": "integer" + }, + { + "description": "the total number of vpcs available to be created for this account", + "name": "vpcavailable", + "type": "string" + }, + { + "description": "account type (admin, domain-admin, user)", + "name": "accounttype", + "type": "integer" + }, + { + "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 name of the account", + "name": "name", + "type": "string" }, { - "description": "the total number of gpus the account can own", - "name": "gpulimit", + "description": "the total backup storage space (in GiB) available to the account", + "name": "backupstorageavailable", "type": "string" }, { - "description": "the total number of gpus owned by account", - "name": "gputotal", - "type": "long" + "description": "the total number of virtual machines stopped for this account", + "name": "vmstopped", + "type": "integer" }, { - "description": "the total number of virtual machines deployed by this account", - "name": "vmtotal", + "description": "the state of the account", + "name": "state", + "type": "string" + }, + { + "description": "path of the Domain the account belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the total memory (in MB) the account can own", + "name": "memorylimit", + "type": "string" + }, + { + "description": "the total memory (in MB) owned by account", + "name": "memorytotal", "type": "long" }, { - "description": "the total number of networks owned by account", - "name": "networktotal", + "description": "the total backup storage space (in GiB) owned by the account", + "name": "backupstoragetotal", "type": "long" }, + { + "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", + "name": "apikeyaccess", + "type": "apikeyaccess" + }, { "description": "the total 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 volume being used by this account", + "name": "volumetotal", "type": "long" }, { - "description": "the total number of templates which can be created by this account", - "name": "templatelimit", - "type": "string" + "description": "the total primary storage space (in GiB) owned by account", + "name": "primarystoragetotal", + "type": "long" }, { - "description": "details for the account", - "name": "accountdetails", - "type": "map" + "description": "the total object storage space (in GiB) available to the account", + "name": "objectstorageavailable", + "type": "string" }, { - "description": "the total object storage space (in GiB) owned by the account", - "name": "objectstoragetotal", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", "type": "long" }, { - "description": "the total primary storage space (in GiB) available to be used for this account", - "name": "primarystorageavailable", + "description": "the total object storage space (in GiB) the account can own", + "name": "objectstoragelimit", "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 total object storage space (in GiB) available to the account", - "name": "objectstorageavailable", + "description": "the total backup storage space (in GiB) the account can own", + "name": "backupstoragelimit", "type": "string" }, { - "description": "the total number of buckets stored by this account", - "name": "buckettotal", - "type": "long" + "description": "the network domain", + "name": "networkdomain", + "type": "string" + }, + { + "description": "the ID of the role", + "name": "roleid", + "type": "string" } ] }, @@ -166712,11 +167493,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,37 +167508,37 @@ "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": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" - } + }, + {}, + {} ], "since": "4.19.1" }, @@ -166776,12 +167557,17 @@ } ], "response": [ + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -166792,12 +167578,7 @@ "name": "displaytext", "type": "string" }, - {}, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - } + {} ], "since": "4.21.0" }, @@ -166823,27 +167604,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" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -166863,211 +167644,336 @@ ], "related": "", "response": [ + { + "description": "the cluster name of the host", + "name": "clustername", + "type": "string" + }, + {}, + { + "description": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", + "type": "boolean" + }, + { + "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 amount of the host's CPU currently allocated in MHz", - "name": "cpuallocatedvalue", - "type": "long" + "description": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", + "type": "string" + }, + { + "description": "the amount of the host's CPU currently used", + "name": "cpuused", + "type": "string" + }, + { + "description": "comma-separated list of explicit host tags for the host", + "name": "explicithosttags", + "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": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", + "name": "remainingcapacity", + "type": "long" + }, + { + "description": "Maximum displays per user", + "name": "maxheads", + "type": "long" + }, + { + "description": "Maximum Y resolution per display", + "name": "maxresolutiony", + "type": "long" + }, + { + "description": "Video RAM for this vGPU type", + "name": "videoram", + "type": "long" + }, + { + "description": "Model Name of vGPU", + "name": "vgputype", + "type": "string" + }, + { + "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", + "name": "maxcapacity", + "type": "long" + }, + { + "description": "Maximum X resolution per display", + "name": "maxresolutionx", + "type": "long" + }, + { + "description": "Maximum no. of vgpu per gpu card (pgpu)", + "name": "maxvgpuperpgpu", + "type": "long" + } + ], + "type": "list" + } + ], + "type": "list" + }, + { + "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", + "name": "hahost", + "type": "boolean" + }, + { + "description": "Host details in key/value pairs.", + "name": "details", + "type": "map" }, {}, + { + "description": "true if the host supports instance conversion (using virt-v2v)", + "name": "instanceconversionsupported", + "type": "boolean" + }, + { + "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", + "name": "cpuwithoverprovisioning", + "type": "string" + }, + { + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "the resource state of the host", + "name": "resourcestate", + "type": "string" + }, { "description": "the number of CPU sockets on the host", "name": "cpusockets", "type": "integer" }, { - "description": "the last annotation set on this host by an admin", - "name": "annotation", + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", "type": "string" }, + { + "description": "the host version", + "name": "version", + "type": "string" + }, + { + "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", + "name": "hasenoughcapacity", + "type": "boolean" + }, + { + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" + }, + { + "description": "the Pod ID of the host", + "name": "podid", + "type": "string" + }, + { + "description": "comma-separated list of storage access groups on the cluster", + "name": "clusterstorageaccessgroups", + "type": "string" + }, + { + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", + "type": "long" + }, { "description": "the date and time the host was last pinged", "name": "lastpinged", "type": "date" }, { - "description": "the OS category ID of the host", - "name": "oscategoryid", + "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", "type": "string" }, { - "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", - "name": "hahost", + "description": "the cluster type of the cluster that host belongs to", + "name": "clustertype", + "type": "string" + }, + { + "description": "Used GPUs on the Host", + "name": "gpuused", + "type": "long" + }, + { + "description": "the amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", + "type": "long" + }, + { + "description": "the admin that annotated this host", + "name": "username", + "type": "string" + }, + { + "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 OS category name of the host", + "name": "oscategoryname", "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the virtual machine id for host type ConsoleProxy and SecondaryStorageVM", - "name": "virtualmachineid", + "description": "comma-separated list of implicit host tags for the host", + "name": "implicithosttags", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" + }, + { + "description": "the Zone ID of the host", + "name": "zoneid", + "type": "string" }, - {}, { "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", "name": "suitableformigration", "type": "boolean" }, { - "description": "CPU Arch of the host", - "name": "arch", + "description": "capabilities of the host", + "name": "capabilities", "type": "string" }, { - "description": "true if the host supports encryption", - "name": "encryptionsupported", - "type": "boolean" + "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "name": "memorytotal", + "type": "long" }, { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", + "description": "events available for the host", + "name": "events", "type": "string" }, { - "description": "the host hypervisor", - "name": "hypervisor", - "type": "string" + "description": "the state of the host", + "name": "state", + "type": "status" }, { - "description": "comma-separated list of explicit host tags for the host", - "name": "explicithosttags", + "description": "the virtual machine id for host type ConsoleProxy and SecondaryStorageVM", + "name": "virtualmachineid", "type": "string" }, { - "description": "the amount of the host's 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": "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 OS category name of the host", - "name": "oscategoryname", - "type": "string" + "description": "true if the host has capability to support UEFI boot", + "name": "ueficapability", + "type": "boolean" }, { - "description": "the IP address of the host", - "name": "ipaddress", + "description": "comma-separated list of storage access groups for the host", + "name": "storageaccessgroups", "type": "string" }, { - "description": "the Pod ID of the host", - "name": "podid", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the cluster ID of the host", - "name": "clusterid", + "description": "the Zone name of the host", + "name": "zonename", "type": "string" }, { - "description": "the host type", - "name": "type", - "type": "type" + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" }, { - "description": "the host version", - "name": "version", + "description": "the IP address of the host", + "name": "ipaddress", "type": "string" }, { - "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", + "description": "Total GPUs on the Host", + "name": "gputotal", "type": "long" }, + { + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", + "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 CPU number of the host", + "name": "cpunumber", + "type": "integer" }, { - "description": "GPU cards present in the host", - "name": "gpugroup", - "response": [ - { - "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", - "type": "long" - }, - { - "description": "Maximum X resolution per display", - "name": "maxresolutionx", - "type": "long" - }, - { - "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", - "name": "maxcapacity", - "type": "long" - }, - { - "description": "Maximum Y resolution per display", - "name": "maxresolutiony", - "type": "long" - }, - { - "description": "Video RAM for this vGPU type", - "name": "videoram", - "type": "long" - }, - { - "description": "Maximum no. of vgpu per gpu card (pgpu)", - "name": "maxvgpuperpgpu", - "type": "long" - }, - { - "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", - "name": "remainingcapacity", - "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 pod", + "name": "podstorageaccessgroups", + "type": "string" }, { "description": "The name of extension for this cluster", @@ -167075,14 +167981,14 @@ "type": "string" }, { - "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", + "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", "type": "string" }, { - "description": "comma-separated list of storage access groups on the pod", - "name": "podstorageaccessgroups", - "type": "string" + "description": "true if the host is disconnected. False otherwise.", + "name": "disconnected", + "type": "date" }, { "description": "The ID of extension for this cluster", @@ -167090,220 +167996,277 @@ "type": "string" }, { - "description": "the management server ID of the host", - "name": "managementserverid", - "type": "string" + "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", - "type": "boolean" + "description": "the date and time the host was created", + "name": "created", + "type": "date" + }, + { + "description": "the hypervisor version", + "name": "hypervisorversion", + "type": "string" }, { - "description": "the resource state of the host", - "name": "resourcestate", - "type": "string" + "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", + "description": "CPU Arch of the host", + "name": "arch", "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 name of the host", + "name": "name", + "type": "string" }, { - "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 CPU number of the host", - "name": "cpunumber", - "type": "integer" + "description": "the amount of the host's memory currently used", + "name": "memoryused", + "type": "long" }, { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", + "description": "the incoming network traffic on the host", + "name": "networkkbsread", "type": "long" }, + {}, { - "description": "the admin that annotated this host", - "name": "username", + "description": "comma-separated list of storage access groups on the zone", + "name": "zonestorageaccessgroups", "type": "string" }, { - "description": "the Pod name of the host", - "name": "podname", + "description": "comma-separated list of tags for the host", + "name": "hosttags", "type": "string" }, { - "description": "Host details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the host type", + "name": "type", + "type": "type" }, { - "description": "the amount of the host's memory currently used", - "name": "memoryused", - "type": "long" + "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", + "description": "the host HA information information", + "name": "hostha", + "type": "hostharesponse" + }, + { + "description": "the host hypervisor", + "name": "hypervisor", "type": "string" }, { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", "type": "boolean" }, { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", + "description": "the amount of the host's memory currently allocated in bytes", + "name": "memoryallocatedbytes", "type": "long" }, { - "description": "the name of the host", - "name": "name", + "description": "the ID of the host", + "name": "id", + "type": "string" + } + ] + }, + { + "description": "Upload a supported Kubernetes version", + "isasync": false, + "name": "getUploadParamsForKubernetesSupportedVersion", + "params": [ + { + "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 current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the minimum number of CPUs to be set with the Kubernetes version", + "length": 255, + "name": "mincpunumber", + "required": true, "type": "integer" }, { - "description": "the cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" + "description": "the minimum RAM size in MB to be set with the Kubernetes version", + "length": 255, + "name": "minmemory", + "required": true, + "type": "integer" }, { - "description": "true if the host supports instance conversion (using virt-v2v)", - "name": "instanceconversionsupported", - "type": "boolean" + "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": "Used GPUs on the Host", - "name": "gpuused", - "type": "long" + "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 host is disconnected. False otherwise.", - "name": "disconnected", - "type": "date" + "description": "Upload volume/template/iso for the project", + "length": 255, + "name": "projectid", + "related": "", + "required": false, + "type": "uuid" }, { - "description": "the state of the host", - "name": "state", - "type": "status" + "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 date and time the host was created", - "name": "created", - "type": "date" + "description": "an optional accountName. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, + "type": "string" }, { - "description": "the Zone ID of the host", - "name": "zoneid", + "description": "the name of the volume/template/iso", + "length": 255, + "name": "name", + "required": true, "type": "string" }, { - "description": "events available for the host", - "name": "events", + "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 management server name of the host", - "name": "managementservername", + "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" - }, + } + ], + "related": "", + "response": [ { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" + "description": "the id of the Kubernetes supported version", + "name": "id", + "type": "string" }, - {}, { - "description": "the date and time the host was removed", - "name": "removed", + "description": "the date when this Kubernetes supported version was created", + "name": "created", "type": "date" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" + "description": "the minimum number of CPUs needed for the Kubernetes supported version", + "name": "mincpunumber", + "type": "integer" }, { - "description": "the host HA information information", - "name": "hostha", - "type": "hostharesponse" + "description": "the minimum RAM size in MB needed for the Kubernetes supported version", + "name": "minmemory", + "type": "integer" }, { - "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": "comma-separated list of tags for the host", - "name": "hosttags", - "type": "string" + "description": "whether Kubernetes supported version supports HA, multi-control nodes", + "name": "supportsha", + "type": "boolean" }, { - "description": "the amount of the host's CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", + "description": "the name of the binaries ISO for Kubernetes supported version", + "name": "isoname", "type": "string" }, { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", + "description": "the enabled or disabled state of the Kubernetes supported version", + "name": "state", "type": "string" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "the name of the zone in which Kubernetes supported version is available", + "name": "zonename", + "type": "string" }, + {}, { - "description": "the cluster name of the host", - "name": "clustername", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "capabilities of the host", - "name": "capabilities", + "description": "the id of the binaries ISO for Kubernetes supported version", + "name": "isoid", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", - "type": "string" + "description": "KVM Only: true if the ISO for the Kubernetes supported version is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", + "type": "boolean" }, { - "description": "the hypervisor version", - "name": "hypervisorversion", + "description": "Kubernetes semantic version", + "name": "semanticversion", "type": "string" }, { - "description": "the last time this host was annotated", - "name": "lastannotated", - "type": "date" + "description": "whether Kubernetes supported version supports Autoscaling", + "name": "supportsautoscaling", + "type": "boolean" }, + {}, { - "description": "the amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", - "type": "long" + "description": "the arch of the binaries ISO for Kubernetes supported version", + "name": "arch", + "type": "string" }, { - "description": "Total GPUs on the Host", - "name": "gputotal", - "type": "long" + "description": "Name of the Kubernetes supported version", + "name": "name", + "type": "string" }, { - "description": "the host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" + "description": "the id of the zone in which Kubernetes supported version is available", + "name": "zoneid", + "type": "string" + }, + { + "description": "the state of the binaries ISO for Kubernetes supported version", + "name": "isostate", + "type": "string" } ] }, @@ -167324,33 +168287,18 @@ "related": "", "response": [ { - "description": "the ID of the service offering of the Kubernetes cluster", - "name": "serviceofferingid", - "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 project id of the Kubernetes cluster", - "name": "projectid", + "description": "the description of the Kubernetes cluster", + "name": "description", "type": "string" }, { - "description": "the ID of the service offering of the etcd nodes on the Kubernetes cluster", - "name": "etcdofferingid", + "description": "the project name of the Kubernetes cluster", + "name": "project", "type": "string" }, { - "description": "the state of the Kubernetes cluster", - "name": "state", + "description": "the name of the zone of the Kubernetes cluster", + "name": "zoneid", "type": "string" }, { @@ -167358,67 +168306,70 @@ "name": "id", "type": "string" }, - {}, { - "description": "the memory the Kubernetes cluster", - "name": "memory", + "description": "Name of CNI Configuration associated with the cluster", + "name": "cniconfigname", "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 type of the cluster", + "name": "clustertype", + "type": "clustertype" + }, + { + "description": "the name of the service offering of the worker nodes on the Kubernetes cluster", + "name": "workerofferingname", "type": "string" }, { - "description": "Whether autoscaling is enabled for the cluster", - "name": "autoscalingenabled", - "type": "boolean" + "description": "the date when this Kubernetes cluster was created", + "name": "created", + "type": "date" }, { - "description": "the project name of the Kubernetes cluster", - "name": "project", + "description": "the ID of the service offering of the control nodes on the Kubernetes cluster", + "name": "controlofferingid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the name of the Kubernetes cluster", + "name": "name", + "type": "string" }, { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zonename", + "description": "the project id of the Kubernetes cluster", + "name": "projectid", "type": "string" }, { - "description": "the ID of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionid", - "type": "string" + "description": "Public IP Addresses of the etcd nodes", + "name": "etcdips", + "type": "map" }, - {}, { - "description": "the ID of the network of the Kubernetes cluster", - "name": "networkid", - "type": "string" + "description": "the size (worker nodes count) of the Kubernetes cluster", + "name": "size", + "type": "long" }, { - "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": "URL end point for the Kubernetes cluster", + "name": "endpoint", "type": "string" }, { - "description": "the control nodes count for the Kubernetes cluster", - "name": "controlnodes", - "type": "long" + "description": "the memory the Kubernetes cluster", + "name": "memory", + "type": "string" }, { "description": "the name of the service offering of the control nodes on the Kubernetes cluster", @@ -167426,114 +168377,120 @@ "type": "string" }, { - "description": "the name of the service offering of the etcd nodes on the Kubernetes cluster", - "name": "etcdofferingname", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the date when this Kubernetes cluster was created", - "name": "created", - "type": "date" + "description": "the ID of the domain in which the Kubernetes cluster exists", + "name": "domainid", + "type": "string" }, { - "description": "URL end point for the Kubernetes cluster", - "name": "endpoint", + "description": "the state of the Kubernetes cluster", + "name": "state", "type": "string" }, { - "description": "the name of the service offering of the worker nodes on the Kubernetes cluster", - "name": "workerofferingname", + "description": "Public IP Address ID of the cluster", + "name": "ipaddressid", "type": "string" }, { - "description": "Name of CNI Configuration associated with the cluster", - "name": "cniconfigname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the name of the Kubernetes cluster", - "name": "name", + "description": "the ID of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the control nodes count for the Kubernetes cluster", + "name": "controlnodes", + "type": "long" }, { - "description": "Public IP Address of the cluster", - "name": "ipaddress", + "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 template of the Kubernetes cluster", + "name": "templateid", "type": "string" }, { - "description": "Public IP Address ID of the cluster", - "name": "ipaddressid", - "type": "string" + "description": "the list of virtualmachine associated with this Kubernetes cluster", + "name": "virtualmachines", + "type": "list" }, { - "description": "Maximum size of the cluster", - "name": "maxsize", + "description": "Minimum size of the cluster", + "name": "minsize", "type": "long" }, { - "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 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": "the type of the cluster", - "name": "clustertype", - "type": "clustertype" + "description": "the number of the etcd nodes on the Kubernetes cluster", + "name": "etcdnodes", + "type": "long" }, { - "description": "the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", - "name": "masternodes", - "type": "long" + "description": "URL end point for the Kubernetes cluster dashboard UI", + "name": "consoleendpoint", + "type": "string" }, { - "description": "the number of the etcd nodes on the Kubernetes cluster", - "name": "etcdnodes", - "type": "long" + "description": "Indicates if the CloudStack CSI driver has been setup in the cluster", + "name": "csienabled", + "type": "boolean" }, { - "description": "the size (worker nodes count) of the Kubernetes cluster", - "name": "size", + "description": "the cpu cores of the Kubernetes cluster", + "name": "cpunumber", + "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", + "description": "path of the domain to which the Kubernetes cluster belongs", + "name": "domainpath", "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": "path of the domain to which the Kubernetes cluster belongs", - "name": "domainpath", + "description": "ID of CNI Configuration associated with the cluster", + "name": "cniconfigurationid", "type": "string" }, { - "description": "the description of the Kubernetes cluster", - "name": "description", + "description": "the ID of the service offering of the worker nodes on the Kubernetes cluster", + "name": "workerofferingid", "type": "string" }, { - "description": "Public IP Addresses of the etcd nodes", - "name": "etcdips", - "type": "map" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the name of the Kubernetes version for the Kubernetes cluster", @@ -167541,8 +168498,13 @@ "type": "string" }, { - "description": "the ID of the template of the Kubernetes cluster", - "name": "templateid", + "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" }, { @@ -167550,20 +168512,26 @@ "name": "domain", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the network of the Kubernetes cluster", + "name": "networkid", "type": "string" }, { - "description": "keypair details", - "name": "keypair", + "description": "the account associated with the Kubernetes cluster", + "name": "account", "type": "string" }, { - "description": "the ID of the domain in which the Kubernetes cluster exists", - "name": "domainid", + "description": "the name of the network of the Kubernetes cluster", + "name": "associatednetworkname", "type": "string" + }, + { + "description": "Maximum size of the cluster", + "name": "maxsize", + "type": "long" } ] }, @@ -167590,17 +168558,11 @@ } ], "response": [ - {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, {}, { "description": "any text associated with the success or failure", @@ -167611,6 +168573,12 @@ "description": "the UUID of the latest async 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" @@ -167644,23 +168612,23 @@ ], "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" }, @@ -167681,20 +168649,19 @@ "related": "listTemplatePermissions,listIsoPermissions", "response": [ { - "description": "the list of projects the template is available for", - "name": "projectids", - "type": "list" + "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 list of projects the template is available for", + "name": "projectids", + "type": "list" }, { "description": "the UUID of the latest async job acting on this object", @@ -167702,19 +168669,20 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", + "type": "boolean" }, + {}, { "description": "the ID of the domain to which the template belongs", "name": "domainid", "type": "string" }, { - "description": "the list of accounts the template is available for", - "name": "account", - "type": "list" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, {} ] @@ -167725,39 +168693,38 @@ "name": "addNetscalerLoadBalancer", "params": [ { - "description": "the Physical Network ID", + "description": "Netscaler device type supports NetscalerMPXLoadBalancer, NetscalerVPXLoadBalancer, NetscalerSDXLoadBalancer", "length": 255, - "name": "physicalnetworkid", - "related": "", + "name": "networkdevicetype", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "public IP of the site", + "description": "true if NetScaler device being added is for providing GSLB service exclusively and can not be used for LB", "length": 255, - "name": "gslbproviderpublicip", + "name": "isexclusivegslbprovider", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "URL of the netscaler load balancer appliance.", + "description": "Credentials to reach netscaler load balancer device", "length": 255, - "name": "url", + "name": "password", "required": true, "type": "string" }, { - "description": "private IP of the site", + "description": "true if NetScaler device being added is for providing GSLB service", "length": 255, - "name": "gslbproviderprivateip", + "name": "gslbprovider", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "Netscaler device type supports NetscalerMPXLoadBalancer, NetscalerVPXLoadBalancer, NetscalerSDXLoadBalancer", + "description": "public IP of the site", "length": 255, - "name": "networkdevicetype", - "required": true, + "name": "gslbproviderpublicip", + "required": false, "type": "string" }, { @@ -167768,39 +168735,30 @@ "type": "string" }, { - "description": "true if NetScaler device being added is for providing GSLB service", + "description": "URL of the netscaler load balancer appliance.", "length": 255, - "name": "gslbprovider", - "required": false, - "type": "boolean" + "name": "url", + "required": true, + "type": "string" }, { - "description": "true if NetScaler device being added is for providing GSLB service exclusively and can not be used for LB", + "description": "the Physical Network ID", "length": 255, - "name": "isexclusivegslbprovider", - "required": false, - "type": "boolean" + "name": "physicalnetworkid", + "related": "", + "required": true, + "type": "uuid" }, { - "description": "Credentials to reach netscaler load balancer device", + "description": "private IP of the site", "length": 255, - "name": "password", - "required": true, + "name": "gslbproviderprivateip", + "required": false, "type": "string" } ], "related": "", "response": [ - { - "description": "device name", - "name": "lbdevicename", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "device id of the netscaler load balancer", "name": "lbdeviceid", @@ -167812,9 +168770,9 @@ "type": "boolean" }, { - "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 state", @@ -167822,8 +168780,13 @@ "type": "string" }, { - "description": "the management IP address of the external load balancer", - "name": "ipaddress", + "description": "the public interface of the load balancer", + "name": "publicinterface", + "type": "string" + }, + { + "description": "name of the provider", + "name": "provider", "type": "string" }, { @@ -167831,51 +168794,56 @@ "name": "privateinterface", "type": "string" }, - {}, { - "description": "the public interface of the load balancer", - "name": "publicinterface", - "type": "string" + "description": "true if device is dedicated for an account", + "name": "lbdevicededicated", + "type": "boolean" }, { "description": "private IP of the NetScaler representing GSLB site", "name": "gslbproviderprivateip", "type": "string" }, - { - "description": "device capacity", - "name": "lbdevicecapacity", - "type": "long" - }, + {}, { "description": "public IP of the NetScaler representing GSLB site", "name": "gslbproviderpublicip", "type": "string" }, { - "description": "true if device is dedicated for an account", - "name": "lbdevicededicated", - "type": "boolean" + "description": "the management IP address of the external load balancer", + "name": "ipaddress", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "device name", + "name": "lbdevicename", + "type": "string" }, { - "description": "name of the provider", - "name": "provider", + "description": "true if NetScaler device is provisioned exclusively to be a GSLB service provider", + "name": "isexclusivegslbprovider", + "type": "boolean" + }, + {}, + { + "description": "the physical network to which this netscaler device belongs to", + "name": "physicalnetworkid", "type": "string" }, + { + "description": "device capacity", + "name": "lbdevicecapacity", + "type": "long" + }, { "description": "Used when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device.", "name": "podids", "type": "list" }, - {}, { - "description": "the physical network to which this netscaler device belongs to", - "name": "physicalnetworkid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ] @@ -167885,20 +168853,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": "If set to false, list only resources belonging to the command's caller; if set to true - list resources 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 ID of the backup schedule", + "length": 255, + "name": "id", + "related": "listBackupSchedule", + "required": false, + "since": "4.22.0", + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, { "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,createVMFromBackup,scaleVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "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": "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, + "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": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" } ], "related": "", "response": [ { - "description": "ID of the backup schedule.", - "name": "id", + "description": "name of the VM", + "name": "virtualmachinename", "type": "string" }, { @@ -167906,47 +168941,47 @@ "name": "jobid", "type": "string" }, + { + "description": "the interval type of the backup schedule", + "name": "intervaltype", + "type": "intervaltype" + }, { "description": "maximum number of backups retained", "name": "maxbackups", "type": "integer" }, + { + "description": "quiesce the instance before checkpointing the disks for backup", + "name": "quiescevm", + "type": "boolean" + }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, { "description": "time the backup is scheduled to be taken.", "name": "schedule", "type": "string" }, { - "description": "name of the VM", - "name": "virtualmachinename", + "description": "ID of the VM", + "name": "virtualmachineid", "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": "ID of the backup schedule.", + "name": "id", "type": "string" - }, - { - "description": "the interval type of the backup schedule", - "name": "intervaltype", - "type": "intervaltype" } ], "since": "4.14.0" @@ -167956,14 +168991,6 @@ "isasync": true, "name": "restoreVolumeFromBackupAndAttachToVM", "params": [ - { - "description": "ID of the VM backup", - "length": 255, - "name": "backupid", - "related": "", - "required": true, - "type": "uuid" - }, { "description": "ID of the volume backed up", "length": 255, @@ -167975,7 +169002,15 @@ "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,createVMFromBackup,scaleVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "required": true, + "type": "uuid" + }, + { + "description": "ID of the VM backup", + "length": 255, + "name": "backupid", + "related": "", "required": true, "type": "uuid" } @@ -167987,22 +169022,22 @@ "type": "string" }, {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, - {} + } ], "since": "4.14.0" }, @@ -168012,10 +169047,9 @@ "name": "removeNetworkPermissions", "params": [ { - "description": "a comma delimited list of projects within owner's domain. If specified, \"op\" parameter has to be passed in.", + "description": "a comma delimited list of accounts within owner's domain. If specified, \"op\" parameter has to be passed in.", "length": 255, - "name": "projectids", - "related": "", + "name": "accounts", "required": false, "type": "list" }, @@ -168027,13 +169061,6 @@ "required": false, "type": "list" }, - { - "description": "a comma delimited list of accounts within owner's domain. If specified, \"op\" parameter has to be passed in.", - "length": 255, - "name": "accounts", - "required": false, - "type": "list" - }, { "description": "the network ID", "length": 255, @@ -168041,30 +169068,38 @@ "related": "createNetwork,updateNetwork,listNetworks", "required": true, "type": "uuid" + }, + { + "description": "a comma delimited list of projects within owner's domain. If specified, \"op\" parameter has to be passed in.", + "length": 255, + "name": "projectids", + "related": "", + "required": false, + "type": "list" } ], "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" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, {} ], "since": "4.17.0" @@ -168075,45 +169110,45 @@ "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" } ], "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - {}, - {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } + {}, + {} ] }, { @@ -168136,13 +169171,6 @@ "required": true, "type": "uuid" }, - { - "description": "Pxe server device ID", - "length": 255, - "name": "id", - "required": false, - "type": "long" - }, { "description": "", "length": 255, @@ -168156,19 +169184,28 @@ "name": "page", "required": false, "type": "integer" + }, + { + "description": "Pxe server device ID", + "length": 255, + "name": "id", + "required": false, + "type": "long" } ], "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": "the current status of the latest 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": "url", @@ -168176,21 +169213,19 @@ "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": "device id of ", + "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" } ] }, @@ -168210,71 +169245,66 @@ "related": "", "response": [ { - "description": "the type of the role", - "name": "roletype", - "type": "string" - }, - { - "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 api key of the user", - "name": "apikey", + "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 account type of the user", + "name": "accounttype", + "type": "integer" }, { - "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", - "type": "string" + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", + "type": "boolean" }, { - "description": "the account ID of the user", - "name": "accountid", + "description": "the 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 firstname", + "name": "firstname", "type": "string" }, { - "description": "the user lastname", - "name": "lastname", + "description": "the user name", + "name": "username", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the secret key of the user", - "name": "secretkey", + "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 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 UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, { "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", "name": "apikeyaccess", @@ -168282,23 +169312,13 @@ }, {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" - }, - { - "description": "the user firstname", - "name": "firstname", - "type": "string" + "description": "the date and time the user account was created", + "name": "created", + "type": "date" }, { - "description": "the timezone user was created in", - "name": "timezone", + "description": "the user state", + "name": "state", "type": "string" }, { @@ -168307,19 +169327,19 @@ "type": "boolean" }, { - "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 account name of the user", - "name": "account", + "description": "the user lastname", + "name": "lastname", "type": "string" }, { - "description": "the domain name of the user", - "name": "domain", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { "description": "the domain ID of the user", @@ -168327,8 +169347,8 @@ "type": "string" }, { - "description": "the user state", - "name": "state", + "description": "the user ID", + "name": "id", "type": "string" }, { @@ -168337,14 +169357,29 @@ "type": "string" }, { - "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 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", + "type": "string" + }, + { + "description": "the account name of the user", + "name": "account", + "type": "string" } ] }, @@ -168354,33 +169389,25 @@ "name": "listLoadBalancerRules", "params": [ { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "fordisplay", + "name": "listall", "required": false, - "since": "4.4", "type": "boolean" }, { - "description": "List resources by tags (key/value pairs)", - "length": 255, - "name": "tags", - "required": false, - "type": "map" - }, - { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "projectid", - "related": "", + "name": "domainid", + "related": "listDomains", "required": false, "type": "uuid" }, { - "description": "list by network ID the rule belongs to", + "description": "the public IP address ID of the load balancer rule", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,listNetworks", + "name": "publicipid", + "related": "associateIpAddress,listPublicIpAddresses", "required": false, "type": "uuid" }, @@ -168392,17 +169419,17 @@ "type": "boolean" }, { - "description": "the public IP address ID of the load balancer rule", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "publicipid", - "related": "associateIpAddress,listPublicIpAddresses", + "name": "projectid", + "related": "", "required": false, "type": "uuid" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "the name of the load balancer rule", "length": 255, - "name": "account", + "name": "name", "required": false, "type": "string" }, @@ -168414,116 +169441,114 @@ "type": "string" }, { - "description": "the name of the load balancer rule", - "length": 255, - "name": "name", - "required": false, - "type": "string" - }, - { - "description": "the ID of the virtual machine of the load balancer rule", + "description": "the availability zone ID", "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": "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": "", "length": 255, - "name": "listall", + "name": "page", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "list only resources belonging to the domain specified", + "description": "the ID of the load balancer rule", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "id", + "related": "", "required": false, "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": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "the ID of the load balancer rule", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "id", - "related": "", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "pagesize", + "name": "tags", "required": false, - "type": "integer" + "type": "map" + }, + { + "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 virtual machine of the load balancer rule", + "length": 255, + "name": "virtualmachineid", + "related": "deployVnfAppliance,listVnfAppliances,createVMFromBackup,scaleVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "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": "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 public ip address id", + "name": "publicipid", "type": "string" }, { - "description": "the name of the load balancer", - "name": "name", + "description": "the id of the guest network the lb rule belongs to", + "name": "networkid", "type": "string" }, { - "description": "the load balancer rule ID", - "name": "id", + "description": "the public port", + "name": "publicport", "type": "string" }, { - "description": "the load balancer algorithm (source, roundrobin, leastconn)", - "name": "algorithm", + "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", + "description": "the domain of the load balancer rule", + "name": "domain", "type": "string" }, { - "description": "the project id of the load balancer", - "name": "projectid", + "description": "the state of the rule", + "name": "state", "type": "string" }, { - "description": "the public ip address", - "name": "publicip", + "description": "the name of the load balancer", + "name": "name", "type": "string" }, { - "description": "the account of the load balancer rule", - "name": "account", + "description": "the load balancer rule ID", + "name": "id", "type": "string" }, { @@ -168531,50 +169556,45 @@ "name": "fordisplay", "type": "boolean" }, + {}, { - "description": "the project name of the load balancer", - "name": "project", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "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", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the description of the load balancer", - "name": "description", + "description": "the public ip address", + "name": "publicip", "type": "string" }, - {}, { - "description": "the id of the guest network the lb rule belongs to", - "name": "networkid", + "description": "the CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { - "description": "the 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 load balancer algorithm (source, roundrobin, leastconn)", + "name": "algorithm", "type": "string" }, { - "description": "the public port", - "name": "publicport", + "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 name of the zone the load balancer rule belongs to", + "name": "zonename", "type": "string" }, { @@ -168582,29 +169602,23 @@ "name": "privateport", "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", + "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" }, { @@ -168613,8 +169627,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" }, { @@ -168623,8 +169637,8 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { @@ -168633,28 +169647,49 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "list" }, { - "description": "the public ip address id", - "name": "publicipid", + "description": "the id of the zone the rule belongs to", + "name": "zoneid", "type": "string" }, { - "description": "the state of the rule", - "name": "state", + "description": "the protocol of the loadbalanacer rule", + "name": "protocol", "type": "string" - } + }, + { + "description": "the description of the load balancer", + "name": "description", + "type": "string" + }, + { + "description": "path of the domain to which the load balancer rule belongs", + "name": "domainpath", + "type": "string" + }, + { + "description": "the account of the load balancer rule", + "name": "account", + "type": "string" + }, + {} ] }, { @@ -168663,9 +169698,9 @@ "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 ending IP address.", "length": 255, - "name": "vlan", + "name": "endip", "required": false, "type": "string" }, @@ -168677,18 +169712,12 @@ "type": "string" }, { - "description": "The netmask for the management network.", - "length": 255, - "name": "netmask", - "required": true, - "type": "string" - }, - { - "description": "The starting IP address.", + "description": "UUID of POD, where the IP range belongs to.", "length": 255, - "name": "startip", + "name": "podid", + "related": "createManagementNetworkIpRange", "required": true, - "type": "string" + "type": "uuid" }, { "description": "Specify if range is dedicated for CPVM and SSVM.", @@ -168698,27 +169727,33 @@ "type": "boolean" }, { - "description": "The ending IP address.", + "description": "The starting IP address.", "length": 255, - "name": "endip", + "name": "startip", + "required": true, + "type": "string" + }, + { + "description": "Optional. The vlan id the ip range sits on, default to Null when it is not specified which means your network is not on any Vlan", + "length": 255, + "name": "vlan", "required": false, "type": "string" }, { - "description": "UUID of POD, where the IP range belongs to.", + "description": "The netmask for the management network.", "length": 255, - "name": "podid", - "related": "createManagementNetworkIpRange", + "name": "netmask", "required": true, - "type": "uuid" + "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 gateway of the Pod", + "name": "gateway", + "type": "string" }, { "description": "the netmask of the Pod", @@ -168726,34 +169761,38 @@ "type": "string" }, { - "description": "comma-separated list of storage access groups on the zone", - "name": "zonestorageaccessgroups", + "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 ID of the Pod", - "name": "zoneid", + "description": "the allocation state of the Pod", + "name": "allocationstate", "type": "string" }, { - "description": "the allocation state of the Pod", - "name": "allocationstate", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { "description": "the ID of the Pod", "name": "id", "type": "string" }, { - "description": "the gateway of the Pod", - "name": "gateway", + "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" }, { @@ -168762,63 +169801,96 @@ "type": "boolean" }, { - "description": "the capacity of the Pod", - "name": "capacity", + "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": "comma-separated list of storage access groups for the pod", + "name": "storageaccessgroups", + "type": "string" + }, + { + "description": "the Zone name of the Pod", + "name": "zonename", + "type": "string" + }, + {}, + { + "description": "indicates if range is dedicated for CPVM and SSVM. This parameter is deprecated, please use 'forsystemvms' from ipranges parameter.", + "name": "forsystemvms", + "type": "list" + }, + { + "description": "the IP ranges for the Pod", + "name": "ipranges", "response": [ { - "description": "the Cluster ID", - "name": "clusterid", + "description": "the ending IP for the range", + "name": "endip", "type": "string" }, { - "description": "the percentage of capacity currently in use", - "name": "percentused", + "description": "the CIDR for the range", + "name": "cidr", "type": "string" }, { - "description": "the total capacity available", - "name": "capacitytotal", - "type": "long" - }, - { - "description": "the capacity currently in use", - "name": "capacityused", - "type": "long" + "description": "indicates Vlan ID for the range", + "name": "vlanid", + "type": "string" }, { - "description": "the Zone ID", - "name": "zoneid", + "description": "indicates if range is dedicated for CPVM and SSVM", + "name": "forsystemvms", "type": "string" }, { - "description": "the Zone name", - "name": "zonename", + "description": "the starting IP for the range", + "name": "startip", "type": "string" }, { - "description": "the Cluster name", - "name": "clustername", + "description": "the gateway for the range", + "name": "gateway", "type": "string" - }, + } + ], + "type": "list" + }, + { + "description": "the ending IP for the Pod. This parameter is deprecated, please use 'endip' from ipranges parameter.", + "name": "endip", + "type": "list" + }, + { + "description": "the capacity of the Pod", + "name": "capacity", + "response": [ { - "description": "the Pod name", - "name": "podname", + "description": "the capacity name", + "name": "name", "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 Zone ID", + "name": "zoneid", "type": "string" }, { - "description": "the capacity type", - "name": "type", - "type": "short" + "description": "the Cluster name", + "name": "clustername", + "type": "string" }, { "description": "the capacity currently in allocated", @@ -168829,83 +169901,46 @@ "description": "The tag for the capacity type", "name": "tag", "type": "string" - } - ], - "type": "list" - }, - { - "description": "comma-separated list of storage access groups for the pod", - "name": "storageaccessgroups", - "type": "string" - }, - { - "description": "the Zone name of the Pod", - "name": "zonename", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the starting IP for the Pod. This parameter is deprecated, please use 'startip' from ipranges parameter.", - "name": "startip", - "type": "list" - }, - { - "description": "indicates Vlan ID for the range. This parameter is deprecated, please use 'vlanid' from ipranges parameter.", - "name": "vlanid", - "type": "list" - }, - { - "description": "the IP ranges for the Pod", - "name": "ipranges", - "response": [ + }, { - "description": "the CIDR for the range", - "name": "cidr", + "description": "the Cluster ID", + "name": "clusterid", "type": "string" }, { - "description": "the gateway for the range", - "name": "gateway", - "type": "string" + "description": "the capacity type", + "name": "type", + "type": "short" }, { - "description": "the starting IP for the range", - "name": "startip", + "description": "the Pod ID", + "name": "podid", "type": "string" }, { - "description": "indicates if range is dedicated for CPVM and SSVM", - "name": "forsystemvms", - "type": "string" + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" }, { - "description": "indicates Vlan ID for the range", - "name": "vlanid", + "description": "the Zone name", + "name": "zonename", "type": "string" }, { - "description": "the ending IP for the range", - "name": "endip", + "description": "the Pod name", + "name": "podname", "type": "string" + }, + { + "description": "the total capacity available", + "name": "capacitytotal", + "type": "long" } ], "type": "list" }, - {}, - { - "description": "the name of the Pod", - "name": "name", - "type": "string" - }, - { - "description": "indicates if range is dedicated for CPVM and SSVM. This parameter is deprecated, please use 'forsystemvms' from ipranges parameter.", - "name": "forsystemvms", - "type": "list" - } + {} ], "since": "4.11.0.0" }, @@ -168915,23 +169950,23 @@ "name": "listCiscoNexusVSMs", "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": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, @@ -168954,24 +169989,25 @@ ], "related": "", "response": [ + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "storage vlan id of the VSM", "name": "vsmstoragevlanid", "type": "int" }, { - "description": "device id of the Cisco N1KV VSM device", - "name": "vsmdeviceid", + "description": "the management IP address of the external Cisco Nexus 1000v Virtual Supervisor Module", + "name": "ipaddress", "type": "string" }, { - "description": "packet vlan id of the VSM", - "name": "vsmpktvlanid", - "type": "int" - }, - { - "description": "The VSM is a switch supervisor. This is the VSM's switch domain id", - "name": "vsmdomainid", + "description": "management vlan id of the VSM", + "name": "vsmmgmtvlanid", "type": "string" }, { @@ -168979,41 +170015,34 @@ "name": "vsmdevicestate", "type": "string" }, - {}, - { - "description": "management vlan id of the VSM", - "name": "vsmmgmtvlanid", - "type": "string" - }, { "description": "The Config State (Primary/Standby) of the VSM", "name": "vsmconfigstate", "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": "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": "control vlan id of the VSM", - "name": "vsmctrlvlanid", - "type": "int" + "description": "The mode of the VSM (standalone/HA)", + "name": "vsmconfigmode", + "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", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "device id of the Cisco N1KV VSM device", + "name": "vsmdeviceid", "type": "string" }, { @@ -169021,10 +170050,16 @@ "name": "vsmdevicename", "type": "string" }, + {}, { - "description": "The Device State (Enabled/Disabled) of the VSM", - "name": "vsmdevicestate", - "type": "string" + "description": "control vlan id of the VSM", + "name": "vsmctrlvlanid", + "type": "int" + }, + { + "description": "packet vlan id of the VSM", + "name": "vsmpktvlanid", + "type": "int" } ] }, @@ -169033,13 +170068,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, @@ -169048,12 +170076,11 @@ "type": "string" }, { - "description": "add vpn user to the specific project", + "description": "an optional account for the vpn user. Must be used with domainId.", "length": 255, - "name": "projectid", - "related": "", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { "description": "an optional domainId for the vpn user. If the account parameter is used, domainId must also be used.", @@ -169064,50 +170091,58 @@ "type": "uuid" }, { - "description": "an optional account for the vpn user. Must be used with domainId.", + "description": "add vpn user to the specific project", "length": 255, - "name": "account", + "name": "projectid", + "related": "", "required": false, + "type": "uuid" + }, + { + "description": "username for the vpn user", + "length": 255, + "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 name of the account of the remote access vpn", + "name": "domain", "type": "string" }, { - "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" }, - {}, { - "description": "the domain id of the account of the remote access vpn", - "name": "domainid", + "description": "the username of the vpn user", + "name": "username", "type": "string" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "the vpn userID", + "name": "id", "type": "string" }, - {}, { - "description": "the vpn userID", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "the username of the vpn user", - "name": "username", + "description": "the account of the remote access vpn", + "name": "account", "type": "string" }, { - "description": "the domain name of the account of the remote access vpn", - "name": "domain", + "description": "the domain id of the account of the remote access vpn", + "name": "domainid", "type": "string" }, { @@ -169115,11 +170150,6 @@ "name": "project", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "path of the domain to which the remote access vpn belongs", "name": "domainpath", @@ -169129,6 +170159,11 @@ "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", + "type": "string" } ] }, @@ -169137,14 +170172,6 @@ "isasync": true, "name": "deleteBackup", "params": [ - { - "description": "id of the VM backup", - "length": 255, - "name": "id", - "related": "", - "required": true, - "type": "uuid" - }, { "description": "force the deletion of backup which removes the entire backup chain but keep VM in Backup Offering", "length": 255, @@ -169152,19 +170179,17 @@ "required": false, "since": "4.18.0.0", "type": "boolean" + }, + { + "description": "id of the VM backup", + "length": 255, + "name": "id", + "related": "", + "required": true, + "type": "uuid" } ], "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, {}, { "description": "any text associated with the success or failure", @@ -169176,6 +170201,16 @@ "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" } ], "since": "4.14.0" @@ -169203,10 +170238,11 @@ } ], "response": [ + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { "description": "any text associated with the success or failure", @@ -169214,16 +170250,15 @@ "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.15.0" @@ -169233,14 +170268,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,20 +170281,24 @@ "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", "type": "string" }, - { - "description": "ID of the account that removed the IP from quarantine.", - "name": "removeraccountid", - "type": "string" - }, { "description": "Account ID of the previous public IP address owner.", "name": "previousownerid", @@ -169278,25 +170309,19 @@ "name": "jobstatus", "type": "integer" }, - { - "description": "The public IP address in quarantine.", - "name": "ipaddress", - "type": "string" - }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "ID of the quarantine process.", "name": "id", "type": "string" }, { - "description": "End date for the quarantine.", - "name": "enddate", + "description": "When the quarantine was created.", + "name": "created", + "type": "date" + }, + { + "description": "When the quarantine was removed.", + "name": "removed", "type": "date" }, {}, @@ -169306,13 +170331,23 @@ "type": "string" }, { - "description": "When the quarantine was removed.", - "name": "removed", - "type": "date" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "When the quarantine was created.", - "name": "created", + "description": "ID of the account that removed the IP from quarantine.", + "name": "removeraccountid", + "type": "string" + }, + { + "description": "The public IP address in quarantine.", + "name": "ipaddress", + "type": "string" + }, + { + "description": "End date for the quarantine.", + "name": "enddate", "type": "date" } ], @@ -169324,126 +170359,119 @@ "name": "updateVnfTemplate", "params": [ { - "description": "true if the template type is routing i.e., if template is used to deploy router", + "description": "optional boolean field, which indicates if VNF nics will be cleaned up or not", "length": 255, - "name": "isrouting", + "name": "cleanupvnfnics", "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", - "length": 255, - "name": "isdynamicallyscalable", + "description": "the display text of the image", + "length": 4096, + "name": "displaytext", "required": false, - "type": "boolean" + "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 name of the image file", "length": 255, - "name": "templatetype", + "name": "name", "required": false, "type": "string" }, { - "description": "Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", + "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": "details", + "name": "vnfnics", "required": false, "type": "map" }, { - "description": "the ID of the image file", + "description": "true if template/ISO contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", "length": 255, - "name": "id", - "related": "listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", - "required": true, - "type": "uuid" + "name": "isdynamicallyscalable", + "required": false, + "type": "boolean" }, { - "description": "optional boolean field, which indicates if VNF details will be cleaned up or not", + "description": "true if the image supports the password reset feature; default is false", "length": 255, - "name": "cleanupvnfdetails", + "name": "passwordenabled", "required": false, "type": "boolean" }, { - "description": "optional boolean field, which indicates if VNF nics will be cleaned up or not", + "description": "indicates that the template can be used for deployment of CKS clusters", "length": 255, - "name": "cleanupvnfnics", + "name": "forcks", "required": false, + "since": "4.21.0", "type": "boolean" }, { - "description": "true if image is bootable, false otherwise; available only for updateIso API", + "description": "sort key of the template, integer", "length": 255, - "name": "bootable", + "name": "sortkey", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "VNF details in key/value pairs using format vnfdetails[i].keyname=keyvalue. Example: vnfdetails[0].vendor=xxx&&vnfdetails[0].version=2.0", + "description": "Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", "length": 255, - "name": "vnfdetails", + "name": "details", "required": false, "type": "map" }, { - "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, - "since": "4.21.0", "type": "boolean" }, { - "description": "the name of the image file", + "description": "true if the template requires HVM, false otherwise; available only for updateTemplate API", "length": 255, - "name": "name", + "name": "requireshvm", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "sort key of the template, integer", + "description": "optional boolean field, which indicates if VNF details will be cleaned up or not", "length": 255, - "name": "sortkey", + "name": "cleanupvnfdetails", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "the ID of the OS type that best represents the OS of this image.", + "description": "the tag for this template.", "length": 255, - "name": "ostypeid", - "related": "", + "name": "templatetag", "required": false, - "type": "uuid" + "since": "4.20.0", + "type": "string" }, { - "description": "true if the template supports the sshkey upload feature; default is false", + "description": "true if image is bootable, false otherwise; available only for updateIso API", "length": 255, - "name": "sshkeyenabled", + "name": "bootable", "required": false, "type": "boolean" }, { - "description": "true if the image supports the password reset feature; default is false", + "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": "passwordenabled", + "name": "forceupdateostype", "required": false, + "since": "4.21", "type": "boolean" }, { @@ -169454,95 +170482,81 @@ "type": "string" }, { - "description": "optional boolean field, which indicates if details should be cleaned up or not (if set to true, details removed for this resource, details field ignored; if false or not set, no action)", + "description": "true if the template supports the sshkey upload feature; default is false", "length": 255, - "name": "cleanupdetails", + "name": "sshkeyenabled", "required": false, "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.", + "description": "the type of the template. Valid options are: USER/VNF (for all users) and SYSTEM/ROUTING/BUILTIN (for admins only).", "length": 255, - "name": "forceupdateostype", + "name": "templatetype", "required": false, - "since": "4.21", - "type": "boolean" + "type": "string" }, { - "description": "true if the template requires HVM, false otherwise; available only for updateTemplate API", + "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": "requireshvm", + "name": "vnfdetails", "required": false, - "type": "boolean" + "type": "map" }, { - "description": "the CPU arch of the template/ISO. Valid options are: x86_64, aarch64", + "description": "the ID of the image file", "length": 255, - "name": "arch", + "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)", + "length": 255, + "name": "cleanupdetails", "required": false, - "since": "4.20", - "type": "string" + "type": "boolean" }, { - "description": "VNF nics in key/value pairs using format vnfnics[i].keyname=keyvalue. Example: vnfnics[0].deviceid=0&&vnfnics[0].name=FirstNIC&&vnfnics[0].required=true&&vnfnics[1].deviceid=1&&vnfnics[1].name=SecondNIC", + "description": "the ID of the OS type that best represents the OS of this image.", "length": 255, - "name": "vnfnics", + "name": "ostypeid", + "related": "", "required": false, - "type": "map" + "type": "uuid" } ], - "related": "listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate", + "related": "registerVnfTemplate,listVnfTemplates,updateVnfTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", "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", - "name": "bootable", + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "name": "isdynamicallyscalable", "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": "the template ID", - "name": "id", + "description": "the name of the zone for this template", + "name": "zonename", "type": "string" }, { - "description": "path of the Domain the template belongs to", - "name": "domainpath", + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", "type": "string" }, { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", "type": "boolean" }, - {}, { - "description": "the processor bit size", - "name": "bits", - "type": "int" + "description": "the ID of the OS type for this template.", + "name": "ostypeid", + "type": "string" }, { "description": "true if this template is a featured template, false otherwise", @@ -169550,93 +170564,33 @@ "type": "boolean" }, { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", "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": "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": "the account name to which the template belongs", "name": "account", "type": "string" }, { - "description": "the name of userdata linked to this template", - "name": "userdataname", + "description": "the name of the OS type for this template.", + "name": "ostypename", "type": "string" }, { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", - "type": "boolean" - }, - { - "description": "the size of the template", - "name": "size", - "type": "long" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { "description": "the date this template was created", - "name": "created", - "type": "date" - }, - { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" - }, - { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" - }, - { - "description": "the name of the domain to which the template belongs", - "name": "domain", - "type": "string" - }, - { - "description": "the URL which the template/iso is registered from", - "name": "url", - "type": "string" - }, - { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" - }, - { - "description": "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" + "name": "created", + "type": "date" }, { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", "type": "boolean" }, { @@ -169644,8 +170598,13 @@ "name": "tags", "response": [ { - "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" }, { @@ -169659,92 +170618,104 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the 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": "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": "id of the resource", - "name": "resourceid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { "description": "the domain associated with the tag", "name": "domain", "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" } ], "type": "set" }, { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" + }, + { + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", "type": "boolean" }, { - "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": "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" }, { - "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": "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 project name of the template", + "name": "project", "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 OS type for this template.", - "name": "ostypeid", + "description": "the ID of the secondary storage host for the template", + "name": "hostid", "type": "string" }, + {}, { - "description": "the template display text", - "name": "displaytext", - "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 format of the template.", + "name": "format", + "type": "imageformat" + }, + { + "description": "the physical size of the template", + "name": "physicalsize", + "type": "long" }, { "description": "the type of the template", @@ -169752,14 +170723,9 @@ "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 template name", + "name": "name", + "type": "string" }, { "description": "the project id of the template", @@ -169767,51 +170733,60 @@ "type": "string" }, { - "description": "The name of extension linked to this template", - "name": "extensionname", + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", "type": "string" }, { - "description": "the project name of the template", - "name": "project", + "description": "the 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 tag of this template", "name": "templatetag", "type": "string" }, { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", + "type": "boolean" + }, + { + "description": "the ID of the zone for this template", + "name": "zoneid", "type": "string" }, { - "description": "the date this template was removed", - "name": "removed", - "type": "date" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the status of the template", + "name": "status", "type": "string" }, { - "description": "the id of userdata linked to this template", - "name": "userdataid", + "description": "the template display text", + "name": "displaytext", "type": "string" }, + { + "description": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" + }, + { + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" + }, {}, { - "description": "the template name", - "name": "name", - "type": "string" + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", + "type": "boolean" }, { "description": "The ID of extension linked to this template", @@ -169819,15 +170794,40 @@ "type": "string" }, { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", + "description": "the ID of the domain to which the template belongs", + "name": "domainid", "type": "string" }, { - "description": "the name of the secondary storage host for the template", - "name": "hostname", + "description": "the processor bit size", + "name": "bits", + "type": "int" + }, + { + "description": "the name of userdata linked to this template", + "name": "userdataname", + "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 extension linked to this template", + "name": "extensionname", "type": "string" }, + { + "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": "true if the template is extractable, false otherwise", "name": "isextractable", @@ -169839,13 +170839,48 @@ "type": "boolean" }, { - "description": "the name of the zone for this template", - "name": "zonename", + "description": "the id of userdata linked to this template", + "name": "userdataid", "type": "string" }, { - "description": "the status of the template", - "name": "status", + "description": "the date this template was removed", + "name": "removed", + "type": "date" + }, + { + "description": "CPU Arch of the template", + "name": "arch", + "type": "string" + }, + { + "description": "the URL which the template/iso is registered from", + "name": "url", + "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 name of the domain to which the template belongs", + "name": "domain", + "type": "string" + }, + { + "description": "checksum of the template", + "name": "checksum", + "type": "string" + }, + { + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", + "type": "boolean" + }, + { + "description": "the template ID", + "name": "id", "type": "string" } ], @@ -169857,18 +170892,12 @@ "name": "updateVPCOffering", "params": [ { - "description": "sort key of the VPC offering, integer", + "description": "the id of the VPC offering", "length": 255, - "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" + "name": "id", + "related": "updateVPCOffering", + "required": true, + "type": "uuid" }, { "description": "the ID of the containing zone(s) as comma separated string, all for all zones offerings", @@ -169879,19 +170908,25 @@ "type": "string" }, { - "description": "update state for the VPC offering; supported states - Enabled/Disabled", + "description": "the display text of the VPC offering", "length": 255, - "name": "state", + "name": "displaytext", "required": false, "type": "string" }, { - "description": "the id of the VPC offering", + "description": "sort key of the VPC offering, integer", "length": 255, - "name": "id", - "related": "updateVPCOffering", - "required": true, - "type": "uuid" + "name": "sortkey", + "required": false, + "type": "integer" + }, + { + "description": "update state for the VPC offering; supported states - Enabled/Disabled", + "length": 255, + "name": "state", + "required": false, + "type": "string" }, { "description": "the name of the VPC offering", @@ -169901,9 +170936,9 @@ "type": "string" }, { - "description": "the display text of the VPC offering", - "length": 255, - "name": "displaytext", + "description": "the ID of the containing domain(s) as comma separated string, public for public offerings", + "length": 4096, + "name": "domainid", "required": false, "type": "string" } @@ -169915,6 +170950,41 @@ "name": "domainid", "type": "string" }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "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": "state of the vpc offering. Can be Disabled/Enabled", + "name": "state", + "type": "string" + }, + { + "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domain", + "type": "string" + }, + { + "description": "true if vpc offering can be used by NSX networks only", + "name": "fornsx", + "type": "boolean" + }, + { + "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zone", + "type": "string" + }, { "description": "true if network offering supports choosing AS numbers", "name": "specifyasnumber", @@ -169922,8 +170992,18 @@ }, {}, { - "description": "the routing mode for the network offering, supported types are Static or Dynamic.", - "name": "routingmode", + "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 zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zoneid", "type": "string" }, { @@ -169931,28 +171011,52 @@ "name": "displaytext", "type": "string" }, - {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the internet protocol of the vpc offering", + "name": "internetprotocol", + "type": "string" + }, + { + "description": "the routing mode for the network offering, supported types are Static or Dynamic.", + "name": "routingmode", + "type": "string" + }, { "description": "the date this vpc offering was created", "name": "created", "type": "date" }, + { + "description": "true if vpc offering is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, { "description": "the list of supported services", "name": "service", "response": [ + { + "description": "the service name", + "name": "name", + "type": "string" + }, { "description": "the list of capabilities", "name": "capability", "response": [ { - "description": "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" }, { @@ -169963,23 +171067,28 @@ ], "type": "list" }, - { - "description": "the service name", - "name": "name", - "type": "string" - }, { "description": "the service provider name", "name": "provider", "response": [ + { + "description": "uuid of the network provider", + "name": "id", + "type": "string" + }, + { + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", + "type": "string" + }, { "description": "the physical network this belongs to", "name": "physicalnetworkid", "type": "string" }, { - "description": "uuid of the network provider", - "name": "id", + "description": "state of the network provider", + "name": "state", "type": "string" }, { @@ -169992,16 +171101,6 @@ "name": "name", "type": "string" }, - { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" - }, - { - "description": "state of the network provider", - "name": "state", - "type": "string" - }, { "description": "services for this provider", "name": "servicelist", @@ -170013,76 +171112,12 @@ ], "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": "state of the vpc offering. Can be Disabled/Enabled", - "name": "state", - "type": "string" - }, - { - "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domain", - "type": "string" - }, - { - "description": "the id of the vpc offering", - "name": "id", - "type": "string" - }, - { - "description": " indicates if the vpc offering supports distributed router for one-hop forwarding", - "name": "distributedvpcrouter", - "type": "boolean" - }, - { - "description": "the name of the vpc offering", - "name": "name", - "type": "string" - }, - { - "description": "Mode in which the network will operate. The valid values are NATTED and ROUTED", - "name": "networkmode", - "type": "string" - }, - { - "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zoneid", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the internet protocol of the vpc offering", - "name": "internetprotocol", - "type": "string" - }, - { - "description": "true if vpc offering can be used by NSX networks only", - "name": "fornsx", - "type": "boolean" - }, - { - "description": "the 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", "type": "boolean" - } + }, + {} ] }, { @@ -170100,16 +171135,12 @@ ], "related": "", "response": [ - { - "description": "the user two factor authenticator provider name", - "name": "name", - "type": "string" - }, + {}, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the description of the user two factor authenticator provider", @@ -170117,11 +171148,15 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, - {} + { + "description": "the user two factor authenticator provider name", + "name": "name", + "type": "string" + } ], "since": "4.18.0" }, @@ -170131,150 +171166,150 @@ "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": "", "length": 255, - "name": "details", + "name": "pagesize", "required": false, - "type": "list" + "type": "integer" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "List by keyword", + "description": "uuid of the extension", "length": 255, - "name": "keyword", + "name": "id", + "related": "listExtensions", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "", + "description": "Name of the extension", "length": 255, - "name": "page", + "name": "name", "required": false, - "type": "integer" + "type": "string" }, { - "description": "Name of the extension", + "description": "List by keyword", "length": 255, - "name": "name", + "name": "keyword", "required": false, "type": "string" }, { - "description": "uuid of the extension", + "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": "id", - "related": "listExtensions", + "name": "details", "required": false, - "type": "uuid" + "type": "list" } ], "related": "", "response": [ - { - "description": "Removal timestamp of the extension, if applicable", - "name": "removed", - "type": "date" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "Description of the extension", "name": "description", "type": "string" }, - { - "description": "The details of the extension", - "name": "details", - "type": "map" - }, { "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 path of the entry point fo the extension", - "name": "path", - "type": "string" - }, - { - "description": "True if the extension is added by admin", - "name": "isuserdefined", - "type": "boolean" - }, - { - "description": "The state of the extension", - "name": "state", - "type": "string" - }, - { - "description": "Name of the extension", - "name": "name", - "type": "string" - }, { "description": "List of resources to which extension is registered to", "name": "resources", "response": [ + { + "description": "the details of the resource map", + "name": "details", + "type": "map" + }, { "description": "Name of the resource associated with this mapping", "name": "name", "type": "string" }, { - "description": "ID of the resource associated with the extension", - "name": "id", + "description": "Type of the resource", + "name": "type", "type": "string" }, { - "description": "Type of the resource", - "name": "type", + "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": "ID of the extension", + "name": "id", + "type": "string" + }, + { + "description": "True if the extension is added by admin", + "name": "isuserdefined", + "type": "boolean" + }, + { + "description": "The path of the entry point fo the extension", + "name": "path", + "type": "string" + }, + {}, + { + "description": "Name of the extension", + "name": "name", + "type": "string" + }, + { + "description": "Removal timestamp of the extension, if applicable", + "name": "removed", + "type": "date" + }, { "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": "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": "Creation timestamp of the extension", + "name": "created", + "type": "date" + }, + { + "description": "The details of the extension", + "name": "details", + "type": "map" } ], "since": "4.21.0" @@ -170285,24 +171320,17 @@ "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", + "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": "Flag for automatic migration of the root volume with new compute offering whenever migration is required to apply the offering", + "description": "Verify OK to Shrink", "length": 255, - "name": "automigrate", + "name": "shrinkok", "required": false, "since": "4.17", "type": "boolean" @@ -170315,19 +171343,11 @@ "since": "4.17", "type": "long" }, - { - "description": "the ID of the service offering for the virtual machine", - "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", - "required": true, - "type": "uuid" - }, { "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,importVm", + "related": "deployVnfAppliance,listVnfAppliances,createVMFromBackup,scaleVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "required": true, "type": "uuid" }, @@ -170338,20 +171358,29 @@ "required": false, "since": "4.17", "type": "long" + }, + { + "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": "the ID of the service offering for the virtual machine", + "length": 255, + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", + "required": true, + "type": "uuid" } ], "response": [ { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, { "description": "true if operation is executed successfully", "name": "success", @@ -170359,10 +171388,16 @@ }, {}, { - "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" - } + }, + {} ] }, { @@ -170370,6 +171405,14 @@ "isasync": true, "name": "updateEgressFirewallRule", "params": [ + { + "description": "the ID of the egress firewall rule", + "length": 255, + "name": "id", + "related": "", + "required": true, + "type": "uuid" + }, { "description": "an optional field, whether to the display the rule to the end user or not", "length": 255, @@ -170385,42 +171428,19 @@ "required": false, "since": "4.4", "type": "string" - }, - { - "description": "the ID of the egress firewall rule", - "length": 255, - "name": "id", - "related": "", - "required": true, - "type": "uuid" } ], "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": "the public ip address id for the firewall rule", + "name": "ipaddressid", + "type": "string" }, { "description": "error code for this icmp message", @@ -170428,9 +171448,9 @@ "type": "integer" }, { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the ending port of firewall rule's port range", + "name": "endport", + "type": "integer" }, { "description": "the public ip address for the firewall rule", @@ -170438,47 +171458,53 @@ "type": "string" }, { - "description": "the traffic type for the firewall rule", - "name": "traffictype", - "type": "string" + "description": "type of the icmp message being sent", + "name": "icmptype", + "type": "integer" + }, + {}, + { + "description": "the starting port of firewall rule's port range", + "name": "startport", + "type": "integer" }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "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 domain associated with the tag", + "name": "domain", "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": "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": "tag key name", - "name": "key", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -170487,37 +171513,41 @@ "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": "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" } ], "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 UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the ID of the firewall rule", - "name": "id", + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the protocol of the firewall rule", + "name": "protocol", "type": "string" }, { @@ -170526,19 +171556,24 @@ "type": "string" }, { - "description": "the starting port of firewall rule's port range", - "name": "startport", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, + { + "description": "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).", + "name": "destcidrlist", + "type": "string" + }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the firewall rule", + "name": "id", "type": "string" }, { - "description": "the public ip address id for the firewall rule", - "name": "ipaddressid", + "description": "the network id of the firewall rule", + "name": "networkid", "type": "string" } ], @@ -170550,28 +171585,10 @@ "name": "listOsCategories", "params": [ { - "description": "List available OS categories types for the zone", - "length": 255, - "name": "zoneid", - "related": "listZones", - "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" - }, - { - "description": "List OS categories types available for given CPU architecture", + "description": "List by keyword", "length": 255, - "name": "arch", + "name": "keyword", "required": false, - "since": "4.21.0", "type": "string" }, { @@ -170583,18 +171600,19 @@ "type": "boolean" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "", + "description": "List OS categories types available for given CPU architecture", "length": 255, - "name": "pagesize", + "name": "arch", "required": false, - "type": "integer" + "since": "4.21.0", + "type": "string" }, { "description": "List OS category by id", @@ -170613,12 +171631,12 @@ "type": "boolean" }, { - "description": "List OS categories for which a VNF template is available", + "description": "List OS category by name", "length": 255, - "name": "isvnf", + "name": "name", "required": false, - "since": "4.21.0", - "type": "boolean" + "since": "3.0.1", + "type": "string" }, { "description": "List OS categories for which an ISO is available", @@ -170628,37 +171646,59 @@ "since": "4.21.0", "type": "boolean" }, + { + "description": "List available OS categories types for the zone", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "since": "4.21.0", + "type": "uuid" + }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" + }, + { + "description": "List OS categories for which a VNF template is available", + "length": 255, + "name": "isvnf", + "required": false, + "since": "4.21.0", + "type": "boolean" } ], "related": "", "response": [ + {}, { - "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 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 name of the OS category", "name": "name", "type": "string" }, + {}, { - "description": "the ID of the OS category", - "name": "id", - "type": "string" + "description": "Whether the OS category is featured", + "name": "isfeatured", + "type": "boolean" }, { "description": "the UUID of the latest async job acting on this object", @@ -170666,14 +171706,9 @@ "type": "string" }, { - "description": "Date when the OS category was created.", - "name": "created", - "type": "date" - }, - { - "description": "Whether the OS category is featured", - "name": "isfeatured", - "type": "boolean" + "description": "the ID of the OS category", + "name": "id", + "type": "string" } ] }, @@ -170683,66 +171718,57 @@ "name": "listServiceOfferings", "params": [ { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "ID of the service offering", "length": 255, - "name": "projectid", - "related": "", + "name": "id", + "related": "updateServiceOffering,listServiceOfferings", "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.", + "description": "", "length": 255, - "name": "gpuenabled", + "name": "page", "required": false, - "since": "4.21.0", - "type": "boolean" + "type": "integer" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "listall", + "name": "isrecursive", "required": false, "type": "boolean" }, { - "description": "the storage type of the service offering. Values are local and shared.", - "length": 255, - "name": "storagetype", - "required": false, - "since": "4.19", - "type": "string" - }, - { - "description": "", + "description": "the RAM memory that listed offering must support", "length": 255, - "name": "pagesize", + "name": "memory", "required": false, + "since": "4.15", "type": "integer" }, { - "description": "the CPU number that listed offerings must support", + "description": "List by keyword", "length": 255, - "name": "cpunumber", + "name": "keyword", "required": false, - "since": "4.15", - "type": "integer" + "type": "string" }, { - "description": "The ID of the vGPU profile that listed offerings must support", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources 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": "vgpuprofileid", - "related": "", + "name": "listall", "required": false, - "since": "4.21.0", - "type": "uuid" + "type": "boolean" }, { - "description": "List by keyword", + "description": "The ID of the template that listed offerings must support", "length": 255, - "name": "keyword", + "name": "templateid", + "related": "registerVnfTemplate,listVnfTemplates,updateVnfTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", "required": false, - "type": "string" + "since": "4.20.0", + "type": "uuid" }, { "description": "the system VM type. Possible types are \"consoleproxy\", \"secondarystoragevm\" or \"domainrouter\".", @@ -170752,81 +171778,74 @@ "type": "string" }, { - "description": "ID of the service offering", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "id", - "related": "updateServiceOffering,listServiceOfferings", + "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.", - "length": 255, - "name": "isrecursive", - "required": false, - "type": "boolean" - }, - { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "id of zone disk offering is associated with", "length": 255, - "name": "account", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "string" + "since": "4.13", + "type": "uuid" }, { - "description": "listed offerings support root disk encryption", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "encryptroot", + "name": "projectid", + "related": "", "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": "the CPU number that listed offerings must support", "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": "cpunumber", "required": false, - "type": "uuid" + "since": "4.15", + "type": "integer" }, { - "description": "", + "description": "the storage type of the service offering. Values are local and shared.", "length": 255, - "name": "page", + "name": "storagetype", "required": false, - "type": "integer" + "since": "4.19", + "type": "string" }, { - "description": "id of zone disk offering is associated with", + "description": "Flag to indicate if the service offering supports GPU. If set to true, only service offerings that support GPU will be returned.", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "gpuenabled", "required": false, - "since": "4.13", - "type": "uuid" + "since": "4.21.0", + "type": "boolean" }, { - "description": "the RAM memory that listed offering must support", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "memory", + "name": "account", "required": false, - "since": "4.15", - "type": "integer" + "type": "string" }, { - "description": "is this a system vm offering", + "description": "", "length": 255, - "name": "issystem", + "name": "pagesize", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "The ID of the template that listed offerings must support", + "description": "the ID of the virtual machine. Pass this in if you want to see the available service offering that a virtual machine can be changed to.", "length": 255, - "name": "templateid", - "related": "listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate", + "name": "virtualmachineid", + "related": "deployVnfAppliance,listVnfAppliances,createVMFromBackup,scaleVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "required": false, - "since": "4.20.0", "type": "uuid" }, { @@ -170837,19 +171856,12 @@ "type": "string" }, { - "description": "Filter by state of the service 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": "list only resources belonging to the domain specified", + "description": "The ID of the vGPU profile that listed offerings must support", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "vgpuprofileid", + "related": "", "required": false, + "since": "4.21.0", "type": "uuid" }, { @@ -170859,205 +171871,203 @@ "required": false, "since": "4.15", "type": "integer" - } - ], - "related": "updateServiceOffering", - "response": [ - { - "description": "restrict the CPU usage to committed service offering", - "name": "limitcpuuse", - "type": "boolean" }, { - "description": "true if disk offering uses custom iops, false otherwise", - "name": "iscustomizediops", + "description": "is this a system vm offering", + "length": 255, + "name": "issystem", + "required": false, "type": "boolean" }, { - "description": "true if virtual machine needs to be dynamically scalable of cpu or memory", - "name": "dynamicscalingenabled", + "description": "listed offerings support root disk encryption", + "length": 255, + "name": "encryptroot", + "required": false, + "since": "4.18", "type": "boolean" }, { - "description": "the ID of the gpu card to which service offering is linked", - "name": "gpucardid", + "description": "Filter by state of the service offering. Defaults to 'Active'. If set to 'all' shows both Active & Inactive offerings.", + "length": 255, + "name": "state", + "required": false, + "since": "4.19", "type": "string" - }, + } + ], + "related": "updateServiceOffering", + "response": [ { - "description": "the cache mode to use for this disk offering. none, writeback or writethrough", - "name": "cacheMode", + "description": "state of the service offering", + "name": "state", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the tags for the service offering", - "name": "storagetags", - "type": "string" + "description": "bytes read rate of the service offering", + "name": "diskBytesReadRate", + "type": "long" }, { - "description": "burst bytes read rate of the disk offering", - "name": "diskBytesReadRateMax", + "description": "length (in second) of the burst", + "name": "diskIopsReadRateMaxLength", "type": "long" }, { - "description": "deployment strategy used to deploy VM.", - "name": "deploymentplanner", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "true if virtual machine root disk will be encrypted on storage", - "name": "encryptroot", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", - "type": "string" - }, - {}, - { - "description": "burst bytes write rate of the disk offering", - "name": "diskBytesWriteRateMax", - "type": "long" - }, - { - "description": "io requests write rate of the service offering", - "name": "diskIopsWriteRate", + "description": "the maximum X resolution", + "name": "maxresolutionx", "type": "long" }, { - "description": "length (in second) of the burst", - "name": "diskIopsReadRateMaxLength", + "description": "length (in seconds) of the burst", + "name": "diskBytesWriteRateMaxLength", "type": "long" }, { - "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domain", + "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 number of CPU", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "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": "diskBytesReadRateMaxLength", + "description": "the maximum number of display heads", + "name": "maxheads", "type": "long" }, { - "description": "length (in seconds) of the burst", - "name": "diskBytesWriteRateMaxLength", - "type": "long" + "description": "is this a system vm offering", + "name": "issystem", + "type": "boolean" }, { - "description": "the maximum X resolution", - "name": "maxresolutionx", - "type": "long" + "description": "the storage type for this service offering", + "name": "storagetype", + "type": "string" }, { - "description": "true if the vm needs to be volatile, i.e., on every reboot of vm from API root disk is discarded and creates a new root disk", - "name": "isvolatile", + "description": "true if disk offering uses custom iops, false otherwise", + "name": "iscustomizediops", "type": "boolean" }, { - "description": "the ha support in the service offering", - "name": "offerha", + "description": "true if virtual machine needs to be dynamically scalable of cpu or memory", + "name": "dynamicscalingenabled", "type": "boolean" }, { - "description": "the vsphere storage policy tagged to the service offering in case of VMware", - "name": "vspherestoragepolicy", + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", "type": "string" }, { - "description": "the min iops of the disk offering", - "name": "miniops", + "description": "burst io requests read rate of the disk offering", + "name": "diskIopsReadRateMax", "type": "long" }, { - "description": "burst io requests write rate of the disk offering", - "name": "diskIopsWriteRateMax", + "description": "length (in seconds) of the burst", + "name": "diskIopsWriteRateMaxLength", "type": "long" }, { - "description": "True/False to indicate the strictness of the disk offering association with the compute offering. When set to true, override of disk offering is not allowed when VM is deployed and change disk offering is not allowed for the ROOT disk after the VM is deployed", - "name": "diskofferingstrictness", - "type": "boolean" + "description": "burst bytes read rate of the disk offering", + "name": "diskBytesReadRateMax", + "type": "long" }, { "description": "the name of the gpu card to which service offering is linked", "name": "gpucardname", "type": "string" }, - { - "description": "Root disk size in GB", - "name": "rootdisksize", - "type": "long" - }, { "description": "the ID of the vgpu profile to which service offering is linked", "name": "vgpuprofileid", "type": "string" }, { - "description": "the count of GPUs to attach ", - "name": "gpucount", + "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", + "name": "hypervisorsnapshotreserve", "type": "integer" }, { - "description": "the clock rate CPU speed in Mhz", - "name": "cpuspeed", - "type": "integer" + "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domainid", + "type": "string" }, + {}, { - "description": "the id of the service offering", - "name": "id", + "description": "restrict the CPU usage to committed service offering", + "name": "limitcpuuse", + "type": "boolean" + }, + { + "description": "deployment strategy used to deploy VM.", + "name": "deploymentplanner", "type": "string" }, + { + "description": "Whether to cleanup VM and its associated resource upon expunge", + "name": "purgeresources", + "type": "boolean" + }, { "description": "an alternate display text of the service offering.", "name": "displaytext", "type": "string" }, { - "description": "data transfer rate in megabits per second allowed.", - "name": "networkrate", - "type": "integer" + "description": "burst bytes write rate of the disk offering", + "name": "diskBytesWriteRateMax", + "type": "long" }, { - "description": "the ID of the disk offering to which service offering is linked", - "name": "diskofferingid", + "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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the tags for the service offering", + "name": "storagetags", "type": "string" }, { - "description": "state of the service offering", - "name": "state", + "description": "is true if the offering is customized", + "name": "iscustomized", + "type": "boolean" + }, + { + "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": "diskBytesReadRateMaxLength", "type": "long" }, { - "description": "the maximum number of display heads", - "name": "maxheads", - "type": "long" + "description": "the clock rate CPU speed in Mhz", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "the count of GPUs to attach ", + "name": "gpucount", + "type": "integer" }, { "description": "the maximum Y resolution", @@ -171065,140 +172075,165 @@ "type": "long" }, { - "description": "is true if the offering is customized", - "name": "iscustomized", - "type": "boolean" + "description": "is this a the systemvm type for system vm offering", + "name": "systemvmtype", + "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": "bytes write rate of the service offering", + "name": "diskBytesWriteRate", + "type": "long" }, { - "description": "Whether to cleanup VM and its associated resource upon expunge", - "name": "purgeresources", + "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": "whether GPU device is used for display or not ", - "name": "gpudisplay", + "description": "true if virtual machine root disk will be encrypted on storage", + "name": "encryptroot", "type": "boolean" }, { - "description": "the host tag for the service offering", - "name": "hosttags", - "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": "is this a system vm offering", - "name": "issystem", - "type": "boolean" + "description": "Root disk size in GB", + "name": "rootdisksize", + "type": "long" + }, + { + "description": "the cache mode to use for this disk offering. none, writeback, writethrough or hypervisor default", + "name": "cacheMode", + "type": "string" }, { "description": "the date this service offering was created", "name": "created", "type": "date" }, - {}, { - "description": "bytes read rate of the service offering", - "name": "diskBytesReadRate", + "description": "the max iops of the disk offering", + "name": "maxiops", "type": "long" }, { - "description": "bytes write rate of the service offering", - "name": "diskBytesWriteRate", + "description": "burst io requests write rate of the disk offering", + "name": "diskIopsWriteRateMax", "type": "long" }, { - "description": "additional key/value details tied with this service offering", - "name": "serviceofferingdetails", - "type": "map" + "description": "the min iops of the disk offering", + "name": "miniops", + "type": "long" }, { - "description": "is this a default system vm offering", - "name": "defaultuse", - "type": "boolean" + "description": "data transfer rate in megabits per second allowed.", + "name": "networkrate", + "type": "integer" }, { - "description": "length (in seconds) of the burst", - "name": "diskIopsWriteRateMaxLength", - "type": "long" + "description": "the name of the service offering", + "name": "name", + "type": "string" }, { - "description": "is this a the systemvm type for system vm offering", - "name": "systemvmtype", - "type": "string" + "description": "the number of CPU", + "name": "cpunumber", + "type": "integer" }, { - "description": "the storage type for this service offering", - "name": "storagetype", - "type": "string" + "description": "the memory in MB", + "name": "memory", + "type": "integer" }, { - "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zoneid", + "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", + "name": "provisioningtype", "type": "string" }, { - "description": "the name of the service offering", - "name": "name", + "description": "the vsphere storage policy tagged to the service offering in case of VMware", + "name": "vspherestoragepolicy", "type": "string" }, { - "description": "the max iops of the disk offering", - "name": "maxiops", - "type": "long" + "description": "name of the disk offering", + "name": "diskofferingname", + "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 name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domain", "type": "string" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "Action to be taken once lease is over", + "name": "leaseexpiryaction", "type": "string" }, { - "description": "the video RAM size in MB", - "name": "videoram", + "description": "io requests write rate of the service offering", + "name": "diskIopsWriteRate", "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 UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "Action to be taken once lease is over", - "name": "leaseexpiryaction", + "description": "the host tag for the service offering", + "name": "hosttags", "type": "string" }, { - "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", - "name": "provisioningtype", - "type": "string" + "description": "is this a default system vm offering", + "name": "defaultuse", + "type": "boolean" }, { - "description": "the memory in MB", - "name": "memory", - "type": "integer" + "description": "additional key/value details tied with this service offering", + "name": "serviceofferingdetails", + "type": "map" }, { - "description": "burst io requests read rate of the disk offering", - "name": "diskIopsReadRateMax", + "description": "the video RAM size in MB", + "name": "videoram", "type": "long" }, { - "description": "the name of the vgpu profile to which service offering is linked", - "name": "vgpuprofilename", - "type": "string" + "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 id of the service offering", + "name": "id", + "type": "string" + }, + { + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", + "type": "string" + }, + { + "description": "the ha support in the service offering", + "name": "offerha", + "type": "boolean" + }, + { + "description": "io requests read rate of the service offering", + "name": "diskIopsReadRate", + "type": "long" } ] }, @@ -171207,20 +172242,6 @@ "isasync": true, "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.", - "length": 255, - "name": "forcemstoimportvmfiles", - "required": false, - "type": "boolean" - }, - { - "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": "hypervisor type of the host", "length": 255, @@ -171229,53 +172250,55 @@ "type": "string" }, { - "description": "VM is imported despite some of its NIC's MAC addresses are already present, in case the MAC address exists then a new MAC address is generated", + "description": "(only for importing VMs from VMware to KVM) Name of VMware datacenter.", "length": 255, - "name": "forced", + "name": "datacentername", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "an optional account for the virtual machine. Must be used with domainId.", + "description": "import instance to the domain specified", "length": 255, - "name": "account", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the password for the host", + "description": "(only for importing VMs from VMware to KVM) VMware ESXi host IP/Name.", "length": 255, - "name": "password", + "name": "hostip", "required": false, "type": "string" }, { - "description": "the zone ID", + "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": "zoneid", - "related": "listZones", - "required": true, - "type": "uuid" + "name": "extraparams", + "required": false, + "since": "4.22", + "type": "string" }, { - "description": "Shared storage pool where disk is located", + "description": "Host where local disk is located", "length": 255, - "name": "storageid", + "name": "hostid", "related": "", "required": false, "type": "uuid" }, { - "description": "(only for importing VMs from VMware to KVM) Name of VMware cluster.", + "description": "import instance for the project", "length": 255, - "name": "clustername", + "name": "projectid", + "related": "", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "(only for importing VMs from VMware to KVM) Name of VMware datacenter.", + "description": "Temp Path on external host for disk image copy", "length": 255, - "name": "datacentername", + "name": "temppath", "required": false, "type": "string" }, @@ -171287,141 +172310,120 @@ "type": "map" }, { - "description": "the ID of the template for the virtual machine", - "length": 255, - "name": "templateid", - "related": "listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate", - "required": false, - "type": "uuid" - }, - { - "description": "the username for the host", - "length": 255, - "name": "username", - "required": false, - "type": "string" - }, - { - "description": "datadisk template to disk-offering mapping using keys disk and diskOffering", + "description": "VM nic to network id mapping using keys nic and network", "length": 255, - "name": "datadiskofferinglist", + "name": "nicnetworklist", "required": false, "type": "map" }, { - "description": "path of the disk image", + "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": "diskpath", + "name": "forcemstoimportvmfiles", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "import instance to the domain specified", + "description": "(only for importing VMs from VMware to KVM) optional - the host to perform the virt-v2v conversion from VMware to KVM.", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "convertinstancehostid", + "related": "", "required": false, "type": "uuid" }, { - "description": "(only for importing VMs from VMware to KVM) UUID of a linked existing vCenter", + "description": "the ID of the template for the virtual machine", "length": 255, - "name": "existingvcenterid", - "related": "", + "name": "templateid", + "related": "registerVnfTemplate,listVnfTemplates,updateVnfTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", "required": false, "type": "uuid" }, { - "description": "VM nic to network id mapping using keys nic and network", + "description": "Shared storage pool where disk is located", "length": 255, - "name": "nicnetworklist", + "name": "storageid", + "related": "", "required": false, - "type": "map" + "type": "uuid" }, { - "description": "Source location for Import", + "description": "the name of the instance as it is known to the hypervisor", "length": 255, - "name": "importsource", + "name": "name", "required": true, "type": "string" }, { - "description": "Temp Path on external host for disk image copy", + "description": "the host name or IP address", "length": 255, - "name": "temppath", + "name": "host", "required": false, "type": "string" }, { - "description": "the service offering for the virtual machine", + "description": "the zone ID", "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering", + "name": "zoneid", + "related": "listZones", "required": true, "type": "uuid" }, { - "description": "the network ID", + "description": "datadisk template to disk-offering mapping using keys disk and diskOffering", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,listNetworks", + "name": "datadiskofferinglist", "required": false, - "type": "uuid" + "type": "map" }, { - "description": "(only for importing VMs from VMware to KVM) VMware ESXi host IP/Name.", + "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": "hostip", + "name": "migrateallowed", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "(only for importing VMs from VMware to KVM) optional - the host to import the converted instance from VMware to KVM.", + "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": "importinstancehostid", - "related": "", + "name": "forced", "required": false, - "since": "4.19.2", - "type": "uuid" + "type": "boolean" }, { - "description": "the host name or IP address", + "description": "the username for the host", "length": 255, - "name": "host", + "name": "username", "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": "the display name of the instance", "length": 255, - "name": "convertinstancehostid", - "related": "", + "name": "displayname", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "Host where local disk is located", + "description": "VM nic to ip address mapping using keys nic, ip4Address", "length": 255, - "name": "hostid", - "related": "", + "name": "nicipaddresslist", "required": false, - "type": "uuid" + "type": "map" }, { - "description": "the cluster ID", + "description": "Source location for Import", "length": 255, - "name": "clusterid", - "related": "", + "name": "importsource", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "import instance for the project", + "description": "path of the disk image", "length": 255, - "name": "projectid", - "related": "", + "name": "diskpath", "required": false, - "type": "uuid" + "type": "string" }, { "description": "(only for importing VMs from VMware to KVM) optional - the temporary storage pool to perform the virt-v2v migration from VMware to KVM.", @@ -171431,20 +172433,6 @@ "required": false, "type": "uuid" }, - { - "description": "the display name of the instance", - "length": 255, - "name": "displayname", - "required": false, - "type": "string" - }, - { - "description": "the host name of the instance", - "length": 255, - "name": "hostname", - "required": false, - "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.", "length": 255, @@ -171453,611 +172441,332 @@ "type": "string" }, { - "description": "the name of the instance as it is known to the hypervisor", - "length": 255, - "name": "name", - "required": true, - "type": "string" - }, - { - "description": "VM nic to ip address mapping using keys nic, ip4Address", - "length": 255, - "name": "nicipaddresslist", - "required": false, - "type": "map" - } - ], - "related": "scaleVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,deployVnfAppliance,listVnfAppliances", - "response": [ - { - "description": "the video RAM size in MB", - "name": "videoram", - "type": "long" - }, - { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", - "type": "string" - }, - { - "description": "the 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": "Guest vm Boot Mode", - "name": "bootmode", - "type": "string" - }, - { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "type": "string" - }, - { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" - }, - { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" - }, - { - "description": "the project name of the affinity group", - "name": "project", - "type": "string" - }, - { - "description": "the name of the affinity group", - "name": "name", - "type": "string" - }, - { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" - }, - { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", - "type": "list" - }, - { - "description": "the description of the affinity group", - "name": "description", - "type": "string" - }, - { - "description": "the type of the affinity group", - "name": "type", - "type": "string" - }, - { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "description": "the ID of the affinity group", - "name": "id", - "type": "string" - }, - { - "description": "the project ID of the affinity group", - "name": "projectid", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", - "type": "string" - }, - { - "description": "the name of the vgpu profile to which service offering is linked", - "name": "vgpuprofilename", - "type": "string" - }, - { - "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": "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 list of nics associated with vm", - "name": "nic", - "response": [ - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "the 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 Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "the 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 gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "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", - "type": "string" - }, - { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", - "type": "string" - }, - { - "description": "the password (if exists) of the virtual machine", - "name": "password", - "type": "string" - }, - { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" - }, - { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "description": "Instance lease duration in days", - "name": "leaseduration", - "type": "integer" - }, - { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", - "type": "string" - }, - { - "description": "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", - "type": "string" - }, - { - "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 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", - "type": "integer" - }, - { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", - "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", - "name": "userdata", - "type": "string" - }, - { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" - }, - { - "description": "CPU arch of the VM", - "name": "arch", - "type": "string" + "description": "(only for importing VMs from VMware to KVM) UUID of a linked existing vCenter", + "length": 255, + "name": "existingvcenterid", + "related": "", + "required": false, + "type": "uuid" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", - "type": "string" + "description": "the service offering for the virtual machine", + "length": 255, + "name": "serviceofferingid", + "related": "updateServiceOffering", + "required": true, + "type": "uuid" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", + "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": "forceconverttopool", + "required": false, + "since": "4.22", "type": "boolean" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "the cluster ID", + "length": 255, + "name": "clusterid", + "related": "", + "required": true, + "type": "uuid" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", - "type": "string" + "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": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "(only for importing VMs from VMware to KVM) Name of VMware cluster.", + "length": 255, + "name": "clustername", + "required": false, "type": "string" }, { - "description": "the count of GPUs on the virtual machine", - "name": "gpucount", - "type": "integer" + "description": "the network ID", + "length": 255, + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks", + "required": false, + "type": "uuid" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "an optional account for the virtual machine. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the password for the host", + "length": 255, + "name": "password", + "required": false, "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": "the host name of the instance", + "length": 255, + "name": "hostname", + "required": false, "type": "string" + } + ], + "related": "deployVnfAppliance,listVnfAppliances,createVMFromBackup,scaleVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines", + "response": [ + { + "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", + "description": "the speed of each vCPU", + "name": "cpuspeed", "type": "integer" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "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": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "the VM's primary IP address", + "name": "ipaddress", "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "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", + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", "type": "long" }, { - "description": "the format of the template for the virtual machine", - "name": "templateformat", + "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": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "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 maximum number of display heads", - "name": "maxheads", - "type": "long" + "description": "the name of the virtual machine", + "name": "name", + "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": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", + "description": "the list of nics associated with vm", + "name": "nic", "response": [ { - "description": "the description of the security group", - "name": "description", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "the account owning the security group", - "name": "account", + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "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": "the broadcast uri of the nic", + "name": "broadcasturi", + "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 ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "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": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", + "response": [ { "description": "the project id of the group", "name": "projectid", @@ -172068,47 +172777,22 @@ "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 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", + "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": "the account associated with the tag", - "name": "account", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -172117,74 +172801,124 @@ "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "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": "resource type", - "name": "resourcetype", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "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 domain associated with the tag", - "name": "domain", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "tag value", - "name": "value", + "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 code for the ICMP message response", + "name": "icmpcode", + "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": "account owning the security group rule", - "name": "account", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { "description": "the id of the security group rule", "name": "ruleid", "type": "string" + }, + { + "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 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 project name of the group", + "name": "project", + "type": "string" + }, { "description": "the domain ID of the security group", "name": "domainid", "type": "string" }, { - "description": "the ID of the security group", - "name": "id", + "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" }, { @@ -172192,18 +172926,28 @@ "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": "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", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -172212,18 +172956,18 @@ "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 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" }, { @@ -172232,43 +172976,23 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "id of the resource", + "name": "resourceid", "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", - "type": "string" - }, { "description": "the number of virtualmachines associated with this securitygroup", "name": "virtualmachinecount", @@ -172279,13 +173003,8 @@ "name": "egressrule", "response": [ { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { @@ -172294,170 +173013,579 @@ "type": "integer" }, { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, { "description": "account owning the security group rule", "name": "account", "type": "string" }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "tag value", - "name": "value", + "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": "tag key name", - "name": "key", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "tag value", + "name": "value", "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 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 code for the ICMP message response", + "name": "icmpcode", + "type": "integer" } ], "type": "set" + } + ], + "type": "set" + }, + { + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", + "type": "string" + }, + { + "description": "the count of GPUs on the virtual machine", + "name": "gpucount", + "type": "integer" + }, + { + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "the project name of the vm", + "name": "project", + "type": "string" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", + "type": "string" + }, + { + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", + "type": "string" + }, + { + "description": "OS type id of the vm", + "name": "ostypeid", + "type": "string" + }, + { + "description": "Guest vm Boot Type", + "name": "boottype", + "type": "string" + }, + { + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", + "type": "string" + }, + { + "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", + "type": "string" + }, + { + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" + }, + { + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", + "type": "string" + }, + { + "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", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "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": "the id of userdata used for the VM", + "name": "userdataid", + "type": "string" + }, + { + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" + }, + { + "description": "the state of the virtual machine", + "name": "state", + "type": "string" + }, + { + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", + "type": "string" + }, + { + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" + }, + { + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" + }, + { + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "the maximum number of display heads", + "name": "maxheads", + "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": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", + "type": "string" + }, + { + "description": "the maximum Y resolution", + "name": "maxresolutiony", + "type": "long" + }, + {}, + { + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "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 format of the template for the virtual machine", + "name": "templateformat", + "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", + "type": "string" + }, + { + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", + "type": "string" + }, + { + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" + }, + { + "description": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" + }, + { + "description": "Base64 string containing the user data", + "name": "userdata", + "type": "string" + }, + { + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" + }, + { + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + { + "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" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", + "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": "CPU arch of the VM", + "name": "arch", + "type": "string" + }, + { + "description": "the account associated with the virtual machine", + "name": "account", + "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 name of the security group", + "description": "the description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name of the affinity group", + "name": "project", + "type": "string" + }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "the name of the affinity group", "name": "name", "type": "string" + }, + { + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + }, + { + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the 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" + }, + { + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" } ], "type": "set" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "the ID of the virtual machine", + "name": "id", + "type": "string" + }, + { + "description": "User VM type", + "name": "vmtype", + "type": "string" + }, + { + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "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 ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" + }, + {}, + { + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, + { + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "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", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the video RAM size in MB", + "name": "videoram", + "type": "long" + }, + { + "description": "the pool type of the virtual machine", + "name": "pooltype", + "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": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "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 control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "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", + "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 received", - "name": "receivedbytes", - "type": "long" + "description": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" }, { "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": "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": "tag key name", - "name": "key", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "tag value", - "name": "value", + "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" }, { @@ -172466,163 +173594,86 @@ "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" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag key name", + "name": "key", "type": "string" } ], "type": "set" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" - }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "device type of the root volume", - "name": "rootdevicetype", - "type": "string" - }, - { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", - "type": "string" - }, - { - "description": "OS type id of the vm", - "name": "ostypeid", - "type": "string" - }, - {}, - { - "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 name of the template for the virtual machine", - "name": "templatename", + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", - "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", + "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 speed of each vCPU", - "name": "cpuspeed", - "type": "integer" - }, - { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "Instance lease expiry action", - "name": "leaseexpiryaction", - "type": "string" - }, - { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", - "type": "string" - }, - { - "description": "State of the Service from LB rule", - "name": "servicestate", - "type": "string" - }, - { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the name of the 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": "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", - "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", + "description": "Guest vm Boot Mode", + "name": "bootmode", "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" } ], @@ -172634,44 +173685,44 @@ "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": [ + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "the current status of the latest 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" } ] }, @@ -172681,11 +173732,11 @@ "name": "listAffinityGroupTypes", "params": [ { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { "description": "", @@ -172695,22 +173746,22 @@ "type": "integer" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "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", @@ -172728,13 +173779,6 @@ "isasync": false, "name": "listCapacity", "params": [ - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, { "description": "List by keyword", "length": 255, @@ -172752,19 +173796,28 @@ "type": "uuid" }, { - "description": "lists capacity by type* CAPACITY_TYPE_MEMORY = 0* CAPACITY_TYPE_CPU = 1* CAPACITY_TYPE_STORAGE = 2* CAPACITY_TYPE_STORAGE_ALLOCATED = 3* CAPACITY_TYPE_VIRTUAL_NETWORK_PUBLIC_IP = 4* CAPACITY_TYPE_PRIVATE_IP = 5* CAPACITY_TYPE_SECONDARY_STORAGE = 6* CAPACITY_TYPE_VLAN = 7* CAPACITY_TYPE_DIRECT_ATTACHED_PUBLIC_IP = 8* CAPACITY_TYPE_LOCAL_STORAGE = 9* CAPACITY_TYPE_GPU = 19* CAPACITY_TYPE_CPU_CORE = 90.", + "description": "lists capacity by the Zone ID", "length": 255, - "name": "type", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "recalculate capacities and fetch the latest", + "description": "lists capacity by the Pod ID", "length": 255, - "name": "fetchlatest", + "name": "podid", + "related": "", "required": false, - "since": "3.0.0", - "type": "boolean" + "type": "uuid" + }, + { + "description": "Tag for the resource type", + "length": 255, + "name": "tag", + "required": false, + "since": "4.20.0", + "type": "string" }, { "description": "Sort the results. Available values: Usage", @@ -172775,53 +173828,61 @@ "type": "string" }, { - "description": "lists capacity by the Pod ID", + "description": "", "length": 255, - "name": "podid", - "related": "", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "lists capacity by the Zone ID", + "description": "recalculate capacities and fetch the latest", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "fetchlatest", "required": false, - "type": "uuid" + "since": "3.0.0", + "type": "boolean" }, { - "description": "Tag for the resource type", + "description": "lists capacity by type* CAPACITY_TYPE_MEMORY = 0* CAPACITY_TYPE_CPU = 1* CAPACITY_TYPE_STORAGE = 2* CAPACITY_TYPE_STORAGE_ALLOCATED = 3* CAPACITY_TYPE_VIRTUAL_NETWORK_PUBLIC_IP = 4* CAPACITY_TYPE_PRIVATE_IP = 5* CAPACITY_TYPE_SECONDARY_STORAGE = 6* CAPACITY_TYPE_VLAN = 7* CAPACITY_TYPE_DIRECT_ATTACHED_PUBLIC_IP = 8* CAPACITY_TYPE_LOCAL_STORAGE = 9* CAPACITY_TYPE_GPU = 19* CAPACITY_TYPE_CPU_CORE = 90.", "length": 255, - "name": "tag", + "name": "type", "required": false, - "since": "4.20.0", - "type": "string" + "type": "integer" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" } ], "related": "", "response": [ + { + "description": "the capacity currently in allocated", + "name": "capacityallocated", + "type": "long" + }, + { + "description": "the total capacity available", + "name": "capacitytotal", + "type": "long" + }, { "description": "the percentage of capacity currently in use", "name": "percentused", "type": "string" }, { - "description": "the capacity currently in use", - "name": "capacityused", - "type": "long" + "description": "the Cluster name", + "name": "clustername", + "type": "string" }, { - "description": "the total capacity available", - "name": "capacitytotal", - "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", @@ -172829,8 +173890,13 @@ "type": "string" }, { - "description": "the capacity name", - "name": "name", + "description": "the Pod ID", + "name": "podid", + "type": "string" + }, + { + "description": "the Pod name", + "name": "podname", "type": "string" }, { @@ -172839,52 +173905,37 @@ "type": "string" }, { - "description": "the Cluster ID", - "name": "clusterid", + "description": "the capacity name", + "name": "name", "type": "string" }, - {}, { - "description": "The tag for the capacity type", - "name": "tag", + "description": "the Zone name", + "name": "zonename", "type": "string" }, { - "description": "the capacity currently in allocated", - "name": "capacityallocated", + "description": "the capacity currently in use", + "name": "capacityused", "type": "long" }, - { - "description": "the Cluster name", - "name": "clustername", - "type": "string" - }, + {}, { "description": "the capacity type", "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", + "description": "The tag for the capacity type", + "name": "tag", "type": "string" }, { - "description": "the Pod ID", - "name": "podid", + "description": "the Cluster ID", + "name": "clusterid", "type": "string" }, - { - "description": "the Pod name", - "name": "podname", - "type": "string" - } + {} ] }, { @@ -172893,31 +173944,63 @@ "name": "updateServiceOffering", "params": [ { - "description": "the display text of the service offering to be updated", + "description": "the ID of the service offering to be updated", "length": 255, - "name": "displaytext", + "name": "id", + "related": "updateServiceOffering", + "required": true, + "type": "uuid" + }, + { + "description": "the host tag for this service offering.", + "length": 255, + "name": "hosttags", "required": false, + "since": "4.16", "type": "string" }, { - "description": "state of the service offering", + "description": "sort key of the service offering, integer", "length": 255, - "name": "state", + "name": "sortkey", + "required": false, + "type": "integer" + }, + { + "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" + }, + { + "description": "Details in key/value pairs using format externaldetails[i].keyname=keyvalue. Example: externaldetails[0].endpoint.url=urlvalue", + "length": 255, + "name": "externaldetails", + "required": false, + "since": "4.21.0", + "type": "map" + }, + { + "description": "the display text of the service offering to be updated", + "length": 255, + "name": "displaytext", "required": false, "type": "string" }, { - "description": "the host tag for this service offering.", + "description": "comma-separated list of tags for the service offering, tags should match with existing storage pool tags", "length": 255, - "name": "hosttags", + "name": "storagetags", "required": false, "since": "4.16", "type": "string" }, { - "description": "the name of the service offering to be updated", + "description": "state of the service offering", "length": 255, - "name": "name", + "name": "state", "required": false, "type": "string" }, @@ -172928,13 +174011,6 @@ "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, @@ -172944,20 +174020,11 @@ "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", + "description": "the name of the service offering to be updated", "length": 255, - "name": "externaldetails", + "name": "name", "required": false, - "since": "4.21.0", - "type": "map" + "type": "string" }, { "description": "the ID of the containing zone(s) as comma separated string, all for all zones offerings", @@ -172966,14 +174033,6 @@ "required": false, "since": "4.13", "type": "string" - }, - { - "description": "comma-separated list of tags for the service offering, tags should match with existing storage pool tags", - "length": 255, - "name": "storagetags", - "required": false, - "since": "4.16", - "type": "string" } ], "related": "", @@ -172984,50 +174043,49 @@ "type": "string" }, { - "description": "length (in seconds) of the burst", - "name": "diskBytesWriteRateMaxLength", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the video RAM size in MB", - "name": "videoram", - "type": "long" + "description": "additional key/value details tied with this service offering", + "name": "serviceofferingdetails", + "type": "map" }, - {}, { - "description": "data transfer rate in megabits per second allowed.", - "name": "networkrate", - "type": "integer" + "description": "is this a system vm offering", + "name": "issystem", + "type": "boolean" }, { - "description": "the ID of the vgpu profile to which service offering is linked", - "name": "vgpuprofileid", - "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 or writethrough", - "name": "cacheMode", - "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": "the ha support in the service offering", + "name": "offerha", + "type": "boolean" }, { - "description": "length (in second) of the burst", - "name": "diskIopsReadRateMaxLength", + "description": "Root disk size in GB", + "name": "rootdisksize", "type": "long" }, { - "description": "the maximum X resolution", - "name": "maxresolutionx", - "type": "long" + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", + "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": "deployment strategy used to deploy VM.", + "name": "deploymentplanner", + "type": "string" }, { "description": "the name of the gpu card to which service offering is linked", @@ -173035,29 +174093,40 @@ "type": "string" }, { - "description": "burst io requests read rate of the disk offering", - "name": "diskIopsReadRateMax", + "description": "length (in seconds) of the burst", + "name": "diskBytesWriteRateMaxLength", "type": "long" }, { - "description": "burst io requests write rate of the disk offering", - "name": "diskIopsWriteRateMax", + "description": "the video RAM size in MB", + "name": "videoram", "type": "long" }, { - "description": "Action to be taken once lease is over", - "name": "leaseexpiryaction", + "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 tags for the service offering", - "name": "storagetags", + "description": "the vsphere storage policy tagged to the service offering in case of VMware", + "name": "vspherestoragepolicy", "type": "string" }, { - "description": "bytes read rate of the service offering", - "name": "diskBytesReadRate", - "type": "long" + "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domain", + "type": "string" + }, + { + "description": "true if virtual machine root disk will be encrypted on storage", + "name": "encryptroot", + "type": "boolean" + }, + {}, + { + "description": "is true if the offering is customized", + "name": "iscustomized", + "type": "boolean" }, { "description": "io requests write rate of the service offering", @@ -173065,48 +174134,68 @@ "type": "long" }, { - "description": "the id of the service offering", - "name": "id", + "description": "burst io requests read rate of the disk offering", + "name": "diskIopsReadRateMax", + "type": "long" + }, + { + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", "type": "string" }, { - "description": "the clock rate CPU speed in Mhz", - "name": "cpuspeed", + "description": "the count of GPUs to attach ", + "name": "gpucount", "type": "integer" }, { - "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", - "name": "provisioningtype", - "type": "string" + "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", + "name": "hypervisorsnapshotreserve", + "type": "integer" }, { - "description": "bytes write rate of the service offering", - "name": "diskBytesWriteRate", - "type": "long" + "description": "true if virtual machine needs to be dynamically scalable of cpu or memory", + "name": "dynamicscalingenabled", + "type": "boolean" }, { - "description": "burst bytes write rate of the disk offering", - "name": "diskBytesWriteRateMax", + "description": "bytes read rate of the service offering", + "name": "diskBytesReadRate", "type": "long" }, { - "description": "the ha support in the service offering", - "name": "offerha", - "type": "boolean" + "description": "the date this service offering was created", + "name": "created", + "type": "date" }, { - "description": "is this a system vm offering", - "name": "issystem", + "description": "restrict the CPU usage to committed service offering", + "name": "limitcpuuse", "type": "boolean" }, + { + "description": "Instance lease duration (in days) for service offering", + "name": "leaseduration", + "type": "integer" + }, { "description": "the maximum Y resolution", "name": "maxresolutiony", "type": "long" }, { - "description": "deployment strategy used to deploy VM.", - "name": "deploymentplanner", + "description": "the tags for the service offering", + "name": "storagetags", + "type": "string" + }, + { + "description": "burst bytes read rate of the disk offering", + "name": "diskBytesReadRateMax", + "type": "long" + }, + { + "description": "the host tag for the service offering", + "name": "hosttags", "type": "string" }, { @@ -173115,129 +174204,104 @@ "type": "long" }, { - "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zoneid", + "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", + "name": "provisioningtype", "type": "string" }, { - "description": "the name of the vgpu profile to which service offering is linked", - "name": "vgpuprofilename", - "type": "string" + "description": "the memory in MB", + "name": "memory", + "type": "integer" }, - {}, { "description": "io requests read rate of the service offering", "name": "diskIopsReadRate", "type": "long" }, { - "description": "the count of GPUs to attach ", - "name": "gpucount", + "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": "length (in second) of the burst", + "name": "diskIopsReadRateMaxLength", + "type": "long" }, { - "description": "true if virtual machine needs to be dynamically scalable of cpu or memory", - "name": "dynamicscalingenabled", - "type": "boolean" + "description": "burst io requests write rate of the disk offering", + "name": "diskIopsWriteRateMax", + "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", + "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 disk offering uses custom iops, false otherwise", - "name": "iscustomizediops", - "type": "boolean" + "description": "data transfer rate in megabits per second allowed.", + "name": "networkrate", + "type": "integer" }, { - "description": "burst bytes read rate of the disk offering", - "name": "diskBytesReadRateMax", + "description": "the max iops of the disk offering", + "name": "maxiops", "type": "long" }, { - "description": "the ID of the gpu card to which service offering is linked", - "name": "gpucardid", + "description": "state of the service offering", + "name": "state", "type": "string" }, { - "description": "true if virtual machine root disk will be encrypted on storage", - "name": "encryptroot", - "type": "boolean" - }, - { - "description": "the number of CPU", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domain", + "description": "an alternate display text of the service offering.", + "name": "displaytext", "type": "string" }, + {}, { - "description": "the ID of the disk offering to which service offering is linked", - "name": "diskofferingid", - "type": "string" + "description": "burst bytes write rate of the disk offering", + "name": "diskBytesWriteRateMax", + "type": "long" }, { - "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domainid", - "type": "string" + "description": "the maximum X resolution", + "name": "maxresolutionx", + "type": "long" }, { - "description": "is this a default system vm offering", - "name": "defaultuse", + "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": "additional key/value details tied with this service offering", - "name": "serviceofferingdetails", - "type": "map" - }, - { - "description": "whether GPU device is used for display or not ", - "name": "gpudisplay", + "description": "is this a default system vm offering", + "name": "defaultuse", "type": "boolean" }, { - "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": "length (in seconds) of the burst", - "name": "diskBytesReadRateMaxLength", - "type": "long" + "description": "the name of the service offering", + "name": "name", + "type": "string" }, { - "description": "Root disk size in GB", - "name": "rootdisksize", + "description": "bytes write rate of the service offering", + "name": "diskBytesWriteRate", "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "is true if the offering is customized", - "name": "iscustomized", - "type": "boolean" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "whether GPU device is used for display or not ", + "name": "gpudisplay", "type": "boolean" }, { - "description": "state of the service offering", - "name": "state", + "description": "the id of the service offering", + "name": "id", "type": "string" }, { @@ -173246,18 +174310,13 @@ "type": "string" }, { - "description": "name of the disk offering", - "name": "diskofferingname", - "type": "string" - }, - { - "description": "the host tag for the service offering", - "name": "hosttags", + "description": "Action to be taken once lease is over", + "name": "leaseexpiryaction", "type": "string" }, { - "description": "an alternate display text of the service offering.", - "name": "displaytext", + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, { @@ -173266,53 +174325,53 @@ "type": "long" }, { - "description": "the max iops of the disk offering", - "name": "maxiops", - "type": "long" + "description": "the storage type for this service offering", + "name": "storagetype", + "type": "string" }, { - "description": "the vsphere storage policy tagged to the service offering in case of VMware", - "name": "vspherestoragepolicy", - "type": "string" + "description": "the number of CPU", + "name": "cpunumber", + "type": "integer" }, { - "description": "the date this service offering was created", - "name": "created", - "type": "date" + "description": "the ID of the disk offering to which service offering is linked", + "name": "diskofferingid", + "type": "string" }, { "description": "Whether to cleanup VM and its associated resource upon expunge", "name": "purgeresources", "type": "boolean" }, - { - "description": "the memory in MB", - "name": "memory", - "type": "integer" - }, { "description": "length (in seconds) of the burst", "name": "diskIopsWriteRateMaxLength", "type": "long" }, { - "description": "the name of the service offering", - "name": "name", + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "True/False to indicate the strictness of the disk offering association with the compute offering. When set to true, override of disk offering is not allowed when VM is deployed and change disk offering is not allowed for the ROOT disk after the VM is deployed", - "name": "diskofferingstrictness", - "type": "boolean" + "description": "the clock rate CPU speed in Mhz", + "name": "cpuspeed", + "type": "integer" }, { - "description": "Instance lease duration (in days) for service offering", - "name": "leaseduration", - "type": "integer" + "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zoneid", + "type": "string" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zone", + "type": "string" + }, + { + "description": "the cache mode to use for this disk offering. none, writeback, writethrough or hypervisor default", + "name": "cacheMode", "type": "string" } ] @@ -173322,93 +174381,42 @@ "isasync": true, "name": "stopVirtualMachine", "params": [ - { - "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", - "required": true, - "type": "uuid" - }, { "description": "Force stop the VM (vm is marked as Stopped even when command fails to be send to the backend, otherwise a force poweroff is attempted). This option is to be used if the caller knows the VM is stopped and should be marked as such.", "length": 255, "name": "forced", "required": false, "type": "boolean" + }, + { + "description": "The ID of the virtual machine", + "length": 255, + "name": "id", + "related": "deployVnfAppliance,listVnfAppliances,createVMFromBackup,scaleVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines", + "required": true, + "type": "uuid" } ], - "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,createVMFromBackup,scaleVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines", "response": [ { - "description": "the format of the template for the virtual machine", - "name": "templateformat", - "type": "string" - }, - { - "description": "State of the Service from LB rule", - "name": "servicestate", - "type": "string" - }, - { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", - "type": "string" - }, - { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "User VM type", - "name": "vmtype", - "type": "string" - }, - { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "true if vm has delete protection.", - "name": "deleteprotection", - "type": "boolean" - }, - { - "description": "CPU arch of the VM", - "name": "arch", - "type": "string" - }, - {}, - { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "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": "device type of the root volume", - "name": "rootdevicetype", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", "type": "string" }, { @@ -173417,261 +174425,155 @@ "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", - "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 memory allocated for the virtual machine", - "name": "memory", - "type": "integer" - }, - { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "the maximum number of display heads", + "name": "maxheads", "type": "long" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "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": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" - }, - { - "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 video RAM size in MB", - "name": "videoram", - "type": "long" - }, - { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "the count of GPUs on the virtual machine", + "name": "gpucount", + "type": "integer" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", + "description": "the list of resource tags associated", + "name": "tags", "response": [ { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" - }, - { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "the project name where tag belongs to", + "name": "project", "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 ID of the affinity group", - "name": "id", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "customer associated with the tag", + "name": "customer", "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", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the account owning the affinity group", - "name": "account", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "tag key name", + "name": "key", "type": "string" - } - ], - "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": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" - }, - { - "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": "Guest vm Boot Mode", - "name": "bootmode", - "type": "string" - }, - { - "description": "the group ID of the virtual machine", - "name": "groupid", - "type": "string" - }, - { - "description": "the ID of the virtual machine", - "name": "id", - "type": "string" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "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 account associated with the tag", + "name": "account", + "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" + } + ], + "type": "set" }, { - "description": "the ID of the gpu card to which service offering is linked", - "name": "gpucardid", + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "the VM's primary IP address", + "name": "ipaddress", "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 Y resolution", + "name": "maxresolutiony", "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 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 name of the host for the virtual machine", - "name": "hostname", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "Instance lease expiry date", - "name": "leaseexpirydate", - "type": "date" + "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 read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" }, { - "description": "the project name of the vm", - "name": "project", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", + "description": "User VM type", + "name": "vmtype", "type": "string" }, { @@ -173679,63 +174581,73 @@ "name": "nic", "response": [ { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", + "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 broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "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": "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": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "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": "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 vpc to which the nic belongs", - "name": "vpcid", + "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": "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": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { @@ -173744,23 +174656,23 @@ "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 IPv6 address of network", - "name": "ip6address", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "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 cidr of IPv6 network", - "name": "ip6cidr", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { @@ -173769,53 +174681,48 @@ "type": "list" }, { - "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 gateway of IPv6 network", - "name": "ip6gateway", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", "type": "integer" }, { - "description": "the ID of the nic", - "name": "id", + "description": "the traffic type of the nic", + "name": "traffictype", "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": "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", + "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 type of the nic", - "name": "type", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { @@ -173824,166 +174731,221 @@ "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" } ], "type": "set" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", + "description": "VNF details", + "name": "vnfdetails", + "type": "map" + }, + { + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" + }, + { + "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 backup offering of the virtual machine", - "name": "backupofferingid", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "Base64 string containing the user data", + "name": "userdata", + "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", + "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": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", + "description": "device ID of the root volume", + "name": "rootdeviceid", "type": "long" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "the id of userdata used for the VM", + "name": "userdataid", "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 count of GPUs on the virtual machine", - "name": "gpucount", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, + { + "description": "the name of userdata used for the VM", + "name": "userdataname", + "type": "string" + }, + { + "description": "the name of the virtual machine", + "name": "name", + "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": "CPU arch of the VM", + "name": "arch", + "type": "string" + }, + { + "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", + "description": "path of the Domain the security group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the domain name of the security group", - "name": "domain", + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the project id of the group", + "name": "projectid", + "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 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": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "the account associated with the tag", - "name": "account", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "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": "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 domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "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": "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": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "resource type", + "name": "resourcetype", "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 id of the security group rule", + "name": "ruleid", "type": "string" }, { @@ -173992,127 +174954,80 @@ "type": "integer" }, { - "description": "account owning the security group rule", - "name": "account", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" + "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" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", + "description": "the code for the ICMP message response", + "name": "icmpcode", "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", - "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 description of the security group", - "name": "description", - "type": "string" + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" }, { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", + "description": "the name of the security group", + "name": "name", "type": "string" }, { - "description": "the project name of the group", - "name": "project", + "description": "the account owning the security group", + "name": "account", "type": "string" }, { - "description": "the name of the security group", - "name": "name", + "description": "the domain ID of the security group", + "name": "domainid", "type": "string" }, { - "description": "the list of resource tags associated with the rule", - "name": "tags", + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", "response": [ { - "description": "resource type", - "name": "resourcetype", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, { - "description": "the account associated with the tag", + "description": "account owning the security group rule", "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", + "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", + "description": "the id of the security group rule", + "name": "ruleid", "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", + "description": "the starting IP of the security group rule", + "name": "startport", "type": "integer" }, { @@ -174120,13 +175035,13 @@ "name": "tags", "response": [ { - "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": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -174135,73 +175050,53 @@ "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "tag 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": "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" }, { - "description": "tag value", - "name": "value", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "resource type", + "name": "resourcetype", "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", + "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 type of the ICMP message response", "name": "icmptype", @@ -174221,51 +175116,113 @@ "type": "set" }, { - "description": "the ID of the security group", - "name": "id", + "description": "the domain name of the security group", + "name": "domain", "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": "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": "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": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + } + ], "type": "set" }, { - "description": "the account owning the security group", - "name": "account", + "description": "the ID of the security group", + "name": "id", "type": "string" - }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" } ], "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 amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the ID of the vgpu profile to which service offering is linked", - "name": "vgpuprofileid", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", + "description": "the maximum X resolution", + "name": "maxresolutionx", "type": "long" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the name of the host for the virtual machine", + "name": "hostname", + "type": "string" + }, + { + "description": "the user's name who deployed the virtual machine", + "name": "username", + "type": "string" + }, + { + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { @@ -174274,54 +175231,90 @@ "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the video RAM size in MB", + "name": "videoram", + "type": "long" + }, + { + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "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": "the memory used by the VM in KiB", - "name": "memorykbs", + "description": "the account associated with the virtual machine", + "name": "account", + "type": "string" + }, + { + "description": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" + }, + { + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", "type": "long" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" + "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", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the maximum Y resolution", - "name": "maxresolutiony", + "description": "the group name of the virtual machine", + "name": "group", + "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 name of the template for the virtual machine", + "name": "templatename", "type": "string" }, + {}, { - "description": "the name of the vgpu profile to which service offering is linked", - "name": "vgpuprofilename", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" + "description": "the format of the template for the virtual machine", + "name": "templateformat", + "type": "string" + }, + { + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", + "type": "string" }, { "description": "an optional field whether to the display the vm to the end user or not.", @@ -174329,172 +175322,238 @@ "type": "boolean" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "the list of resource tags associated", - "name": "tags", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", + "type": "string" + }, + { + "description": "the password (if exists) of the virtual machine", + "name": "password", + "type": "string" + }, + { + "description": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" + }, + { + "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", + "type": "string" + }, + { + "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 project name where tag belongs to", - "name": "project", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" }, { - "description": "tag value", - "name": "value", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the type of the affinity group", + "name": "type", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "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": "tag key name", - "name": "key", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" } ], "type": "set" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "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": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "Instance lease duration in days", + "name": "leaseduration", + "type": "integer" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", - "type": "string" + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", - "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", + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, + { + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, + {}, { "description": "the number of vCPUs this virtual machine is using", "name": "cpunumber", "type": "integer" }, { - "description": "Base64 string containing the user data", - "name": "userdata", - "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": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "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": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", + "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 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 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", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, - {}, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", + "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" + }, + { + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" } ] }, @@ -174503,14 +175562,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, @@ -174526,6 +175577,14 @@ "required": false, "type": "string" }, + { + "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": "Name of the network ACL list", "length": 255, @@ -174536,25 +175595,14 @@ ], "related": "", "response": [ - {}, - { - "description": "the Name of the ACL", - "name": "name", - "type": "string" - }, - { - "description": "Id of the VPC this ACL is associated with", - "name": "vpcid", - "type": "string" - }, { - "description": "Description of the ACL", - "name": "description", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the ID of the ACL", - "name": "id", + "description": "the Name of the ACL", + "name": "name", "type": "string" }, { @@ -174569,17 +175617,28 @@ }, {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Description of the ACL", + "name": "description", + "type": "string" + }, + { + "description": "Id of the VPC this ACL is associated with", + "name": "vpcid", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - } + }, + { + "description": "the ID of the ACL", + "name": "id", + "type": "string" + }, + {} ] } ], - "count": 899 + "count": 902 } diff --git a/test/BackupService_test.go b/test/BackupService_test.go index 9fa8329..0ce53fb 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 eb3632d..90fa13e 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)